asciidoctor-html5s 0.3.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e092a76fce65ac3bf02c38c39060252c0ffc2c1793baa6fa5e349f3c5facd99c
-  data.tar.gz: 5d28b658e4ed1e4bfccdbc8226d326bd9d33bb15a63a14f84a5b1e37bd56afa2
+  metadata.gz: 630da0664ff127034ff14612b42ccfd524f9c37b8dbad7fd86631fef516fc731
+  data.tar.gz: 7eef8c8b6512eb08da9cd4bce496e984a6d9b5a21925fc933c13276d40359990
 SHA512:
-  metadata.gz: 79fde10526f24f6e819f2475427be3016df9b550da8f4ef035c99961ff8573285a9eed89438629d7a9461c059a601664c228f64caa46bec781728de7b421f6e1
-  data.tar.gz: 5beea3877ff5ad48750b5be4ca61b5bebce4daa9b64054e2b5220d3234d1094d3b4e33c71737a8cf07d9ccf1ff2c3d886bf026bfddbefb94595d990b57b75e86
+  metadata.gz: b8919b949ca260a57dc2555f8ee3bff088b4608cef4ac107be9fa922def409054ffb2ef0b6ea4ece811daf19e4528be910cc5d8ae11a2136de320b688be6cfa4
+  data.tar.gz: 717270402b7f40ba2266e0d13594b6bdec16a644e76f6c32454812f9f10fae0806e483bfa7d97b303f2213acb0740db33404903d561b7e3c27be89c516a474ae

data/README.adoc

@@ -5,7 +5,7 @@
 :gh-branch: master
 
 ifdef::env-github[]
-image:https://travis-ci.org/{gh-name}.svg?branch={gh-branch}[Build Status, link="https://travis-ci.org/{gh-name}"]
+image:https://github.com/{gh-name}/workflows/CI/badge.svg[CI Status, link=https://github.com/{gh-name}/actions?query=workflow%3A%22CI%22]
 image:https://img.shields.io/gem/v/{gem-name}.svg?style=flat[Gem Version, link="https://rubygems.org/gems/{gem-name}"]
 image:https://img.shields.io/npm/v/{gem-name}.svg?style=flat[npm Version, link="https://www.npmjs.org/package/{gem-name}"]
 endif::env-github[]
@@ -125,6 +125,19 @@ link=none / link=false::
 Both block image and inline image supports additional attribute `loading` (see https://developer.mozilla.org/en-US/docs/Web/Performance/Lazy_loading#Images[Lazy loading] on MDN for more information).
 
 
+=== Additional Inline Formatting Roles
+
+del::
+  `++[del]#deleted text#++` is rendered as `<del>deleted text</del>`.
+
+ins::
+  `++[ins]#inserted text#++` is rendered as `<ins>inserted text</ins>`.
+
+strike::
+  `++[strike]#inserted text#++` is rendered as `<s>inserted text</s>`.
+  This is an alias for `line-through`.
+
+
 == Requirements
 
 Note: This converter consists of https://github.com/slim-template/slim/[Slim] templates, but they are precompiled into pure Ruby code using https://github.com/jirutka/asciidoctor-templates-compiler/[asciidoctor-templates-compiler], so you don’t need Slim to use it!
@@ -133,7 +146,7 @@ ifndef::npm-readme[]
 === Ruby
 
 * https://www.ruby-lang.org/[Ruby] 2.0+ or http://jruby.org/[JRuby] 9.1+
-* https://rubygems.org/gems/asciidoctor/[Asciidoctor] 1.5.5+
+* https://rubygems.org/gems/asciidoctor/[Asciidoctor] 1.5.7+
 * https://rubygems.org/gems/thread_safe/[thread_safe] (not required, but recommended for Ruby MRI)
 
 
@@ -141,7 +154,7 @@ ifndef::npm-readme[]
 endif::npm-readme[]
 
 * https://nodejs.org/[Node.js]
-* https://www.npmjs.com/package/@asciidoctor/core[@asciidoctor/core] >=2.0.0 <2.2.0
+* https://www.npmjs.com/package/@asciidoctor/core[@asciidoctor/core] >=2.0.0 <3.0.0
 
 
 == Installation

data/asciidoctor-html5s.gemspec

@@ -21,15 +21,14 @@ EOF
 
   s.required_ruby_version = '>= 2.0'
 
-  s.add_runtime_dependency 'asciidoctor', '>= 1.5.5', '< 3.0'
+  s.add_runtime_dependency 'asciidoctor', '>= 1.5.7', '< 3.0'
   s.add_runtime_dependency 'thread_safe', '~> 0.3.4'
 
-  s.add_development_dependency 'asciidoctor-doctest', '= 2.0.0.beta.6'
+  s.add_development_dependency 'asciidoctor-doctest', '= 2.0.0.beta.7'
   s.add_development_dependency 'asciidoctor-templates-compiler', '~> 0.6.0'
   s.add_development_dependency 'bundler', '>= 1.6'
-  s.add_development_dependency 'coderay', '~> 1.1'
   s.add_development_dependency 'pandoc-ruby', '~> 2.0'
-  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'slim', '~> 3.0'
   s.add_development_dependency 'slim-htag', '~> 0.1.0'
 end

data/data/templates/_header.html.slim

@@ -1,4 +1,4 @@
-- if has_header?
+- if header?
   - unless notitle
     h1 =header.title
   - if [:author, :revnumber, :revdate, :revremark].any? {|a| attr? a }

data/data/templates/dlist.html.slim

@@ -1,13 +1,7 @@
-- case style
-- when 'qanda'
-  include _qanda.html
-- when 'horizontal'
-  include _hdlist.html
-- else
-  = block_with_title :class=>['dlist', style]
-    dl
-      - items.each do |terms, dd|
-        - [*terms].each do |dt|
-          dt =dt.text
-        - unless dd.nil?
-          dd =(print_item_content dd)
+= block_with_title :class=>['dlist', style], :role=>('doc-qna' if style == 'qanda')
+  dl class=style
+    - items.each do |terms, dd|
+      - [*terms].each do |dt|
+        dt =dt.text
+      - unless dd.nil?
+        dd =(print_item_content dd)

data/data/templates/document.html.slim

@@ -1,9 +1,13 @@
 doctype 5
 html lang=(attr :lang, 'en' unless attr? :nolang)
+  / Render the document content before styles_and_scripts -
+  / SyntaxHighlighter#docinfo must be called after SyntaxHighlighter#highlight
+  / because some highlighter plugins emit style/script tags only when
+  / #highlight was called at least once.
+  - document_content = content
   head
     meta charset=(attr :encoding, 'UTF-8')
-    /[if IE]
-      meta http-equiv="X-UA-Compatible" content="IE=edge"
+    meta http-equiv="X-UA-Compatible" content="IE=edge"
     meta name='viewport' content='width=device-width, initial-scale=1.0'
     meta name='generator' content="Asciidoctor #{attr 'asciidoctor-version'}"
     = html_meta_if 'application-name', (attr 'app-name')
@@ -17,12 +21,16 @@ html lang=(attr :lang, 'en' unless attr? :nolang)
       =docinfo_content
   body [
       id=id
-      class=[(attr :doctype), ("#{attr 'toc-class'} toc-#{attr 'toc-position', 'left'}" if (attr? 'toc-class') && (attr? :toc) && (attr? 'toc-placement', 'auto'))]
+      class=[(attr :doctype),
+             ("#{attr 'toc-class'} toc-#{attr 'toc-position', 'left'}" if (attr? 'toc-class') && (attr? :toc) && (attr? 'toc-placement', 'auto')),
+             (attr :docrole) || (attr :role)]
       style=style_value(max_width: (attr 'max-width')) ]
+    - unless (docinfo_content = (docinfo :header)).empty?
+      =docinfo_content
     - unless noheader
       header
         include _header.html
-    #content =content
+    #content =document_content
     - unless !footnotes? || (attr? :nofootnotes)
       include _footnotes.html
     - unless nofooter

data/data/templates/embedded.html.slim

@@ -1,4 +1,4 @@
-- if !notitle && has_header?
+- if !notitle && header?
   h1 id=id =header.title
 - if node.sections? && (attr? :toc) && (attr 'toc-placement', 'auto') == 'auto'
   include _toc.html

data/data/templates/example.html.slim

@@ -1,3 +1,11 @@
-= block_with_caption :top, :class=>'example-block'
-  .example
-    =content
+- if option? :collapsible
+  details id=id class=role open=(option? :open)
+    - if title
+      summary
+        =title
+    .content
+      =content
+- else
+  = block_with_caption :top, :class=>'example-block'
+    .example
+      =content

data/data/templates/helpers.rb

@@ -1,5 +1,4 @@
 require 'asciidoctor/html5s'
-require 'asciidoctor/html5s/logger'
 require 'date' unless RUBY_PLATFORM == 'opal'
 
 # Add custom functions to this module that you want to use in your Slim
@@ -8,10 +7,11 @@ require 'date' unless RUBY_PLATFORM == 'opal'
 module Slim::Helpers
 
   # URIs of external assets.
-  FONT_AWESOME_URI     = '//cdn.jsdelivr.net/npm/font-awesome@4.7.0/css/font-awesome.min.css'
-  HIGHLIGHTJS_BASE_URI = '//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.12.0/build/'
-  KATEX_CSS_URI        = '//cdn.jsdelivr.net/npm/katex@0.9.0/dist/katex.min.css'
-  KATEX_JS_URI         = '//cdn.jsdelivr.net/npm/katex@0.9.0/dist/katex.min.js'
+  CDN_BASE_URI         = 'https://cdnjs.cloudflare.com/ajax/libs'  # for highlighters in Asciidoctor >=2.0.0
+  FONT_AWESOME_URI     = 'https://cdn.jsdelivr.net/npm/font-awesome@4.7.0/css/font-awesome.min.css'
+  HIGHLIGHTJS_BASE_URI = 'https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.15.1/build/'
+  KATEX_CSS_URI        = 'https://cdn.jsdelivr.net/npm/katex@0.11.1/dist/katex.min.css'
+  KATEX_JS_URI         = 'https://cdn.jsdelivr.net/npm/katex@0.11.1/dist/katex.min.js'
 
   # Defaults
   DEFAULT_HIGHLIGHTJS_THEME = 'github'
@@ -53,7 +53,7 @@ module Slim::Helpers
 
   # @return [Logger]
   def log
-    @_html5s_logger ||= ::Asciidoctor::Html5s::Logging.default_logger
+    ::Asciidoctor::LoggerManager.logger
   end
 
   ##
@@ -376,15 +376,29 @@ module Slim::Helpers
   # Returns the captioned section's title, optionally numbered.
   #
   # @param sec [Asciidoctor::Section] the section node (default: self).
+  # @param drop_anchors [Boolean] Remove +<a>+ tags from the title?
   # @return [String]
   #
-  def section_title(sec = self)
-    sectnumlevels = document.attr(:sectnumlevels, DEFAULT_SECTNUMLEVELS).to_i
+  def section_title(sec = self, drop_anchors: false)
+    title =
+      if sec.caption
+        sec.captioned_title
+      elsif sec.numbered && sec.level <= document.attr(:sectnumlevels, DEFAULT_SECTNUMLEVELS).to_i
+        if sec.level < 2 && document.doctype == 'book' && %w[chapter part].include?(sec.sectname)
+          signifier = document.attr("#{sec.sectname}-signifier")
+          sectnum = sec.sectname == 'part' ? sec.sectnum(nil, ':') : sec.sectnum
+          "#{signifier&.+ ' '}#{sectnum} #{sec.title}"
+        else
+          "#{sec.sectnum} #{sec.title}"
+        end
+      else
+        sec.title
+      end
 
-    if sec.numbered && !sec.caption && sec.level <= sectnumlevels
-      [sec.sectnum, sec.captioned_title].join(' ')
+    if drop_anchors && title.include?('<a')
+      title.gsub(/<(?:a[^>+]+|\/a)>/, '')
     else
-      sec.captioned_title
+      title
     end
   end
 
@@ -396,7 +410,12 @@ module Slim::Helpers
   end
 
   def link_rel
-    'noopener' if option?('noopener') || attr(:window) == '_blank'
+    rel = [
+      ('nofollow' if option?('nofollow')),
+      ('noopener' if option?('noopener') || local_attr(:window) == '_blank')
+    ].compact
+
+    rel.empty? ? nil : rel.join(' ')
   end
 
   #--------------------------------------------------------
@@ -455,15 +474,19 @@ module Slim::Helpers
   #
 
   ##
-  # @return [String] a canonical name of the source-highlighter to be used as
-  #         a style class.
-  def highlighter
-    @_html5s_highlighter ||=
-      case (highlighter = document.attr('source-highlighter'))
-      when 'coderay'; 'CodeRay'
-      when 'highlight.js'; 'highlightjs'
-      else highlighter
-      end
+  # See {Asciidoctor::SyntaxHighlighter#format}.
+  #
+  # @return [String, nil] a rendered HTML.
+  def formatted_source
+    hl = document.syntax_highlighter or return nil
+
+    opts = { nowrap: nowrap? }
+    if hl.highlight?
+      opts[:css_mode] = document.attr("#{hl.name}-css", :class).to_sym
+      opts[:style] = document.attr("#{hl.name}-style")
+    end
+
+    hl.format(self, source_lang, opts)
   end
 
   ##
@@ -481,6 +504,15 @@ module Slim::Helpers
     local_attr :language, false
   end
 
+  # This is needed only for Asciidoctor <2.0.0.
+  def source_code_class
+    if document.attr? 'source-highlighter', 'highlightjs'
+      "language-#{source_lang || 'none'} hljs"
+    elsif source_lang
+      "language-#{source_lang}"
+    end
+  end
+
   #--------------------------------------------------------
   # block_open
   #
@@ -502,7 +534,7 @@ without a title when doctype is book. Excluding block content.'
   def partintro_allowed?
     if result = (level != 0 || parent.context != :section || document.doctype != 'book')
       log.warn "asciidoctor: ERROR: partintro block can only be used when doctype
-is book and it's a child of a book part. Excluding block content."
+is book and must be a child of a book part. Excluding block content."
     end
     !result
   end
@@ -511,13 +543,13 @@ is book and it's a child of a book part. Excluding block content."
   # block_table
   #
 
-  def autowidth?
-    option? :autowidth
+  def autowidth?(node = self)
+    node.option? :autowidth
   end
 
-  def spread?
+  def stretch?
     if !autowidth? || local_attr?('width')
-      'spread' if attr? :tablepcwidth, 100
+      'stretch' if attr? :tablepcwidth, 100
     end
   end
 
@@ -535,7 +567,8 @@ is book and it's a child of a book part. Excluding block content."
     when :vimeo
       params = {
         autoplay: (1 if option? 'autoplay'),
-        loop:     (1 if option? 'loop')
+        loop:     (1 if option? 'loop'),
+        muted:    (1 if option? 'muted')
       }
       start_anchor = "#at=#{attr :start}" if attr? :start
       "//player.vimeo.com/video/#{attr :target}#{start_anchor}#{url_query params}"
@@ -549,6 +582,7 @@ is book and it's a child of a book part. Excluding block content."
         list:     (attr :list, list_id),
         autoplay: (1 if option? 'autoplay'),
         loop:     (1 if option? 'loop'),
+        muted:    (1 if option? 'muted'),
         controls: (0 if option? 'nocontrols')
       }
       "//www.youtube.com/embed/#{video_id}#{url_query params}"
@@ -603,10 +637,9 @@ is book and it's a child of a book part. Excluding block content."
     stylesheet = attr :stylesheet
     stylesdir = attr :stylesdir, ''
     default_style = ::Asciidoctor::DEFAULT_STYLESHEET_KEYS.include? stylesheet
-    linkcss = attr?(:linkcss) || safe >= ::Asciidoctor::SafeMode::SECURE
     ss = ::Asciidoctor::Stylesheets.instance
 
-    if linkcss
+    if attr?(:linkcss)
       path = default_style ? ::Asciidoctor::DEFAULT_STYLESHEET_NAME : stylesheet
       styles << { href: [stylesdir, path] }
     elsif default_style
@@ -629,23 +662,15 @@ is book and it's a child of a book part. Excluding block content."
       scripts << { text: KATEX_RENDER_CODE }
     end
 
-    case attr 'source-highlighter'
-    when 'coderay'
-      if attr('coderay-css', 'class') == 'class'
-        if linkcss
-          styles << { href: [stylesdir, ss.coderay_stylesheet_name] }
-        else
-          styles << { text: ss.coderay_stylesheet_data }
-        end
-      end
+    if !defined?(::Asciidoctor::SyntaxHighlighter)  # Asciidoctor <2.0.0
+      if attr? 'source-highlighter', 'highlightjs'
+        hjs_base = attr :highlightjsdir, HIGHLIGHTJS_BASE_URI
+        hjs_theme = attr 'highlightjs-theme', DEFAULT_HIGHLIGHTJS_THEME
 
-    when 'highlightjs'
-      hjs_base = attr :highlightjsdir, HIGHLIGHTJS_BASE_URI
-      hjs_theme = attr 'highlightjs-theme', DEFAULT_HIGHLIGHTJS_THEME
-
-      scripts << { src: [hjs_base, 'highlight.min.js'] }
-      scripts << { text: 'hljs.initHighlightingOnLoad()' }
-      styles  << { href: [hjs_base, "styles/#{hjs_theme}.min.css"] }
+        scripts << { src: [hjs_base, 'highlight.min.js'] }
+        scripts << { text: 'hljs.initHighlightingOnLoad()' }
+        styles  << { href: [hjs_base, "styles/#{hjs_theme}.min.css"] }
+      end
     end
 
     styles.each do |item|
@@ -664,6 +689,15 @@ is book and it's a child of a book part. Excluding block content."
       end
     end
 
+    if defined?(::Asciidoctor::SyntaxHighlighter) && (hl = syntax_highlighter)  # Asciidoctor >=2.0.0
+      # XXX: We don't care about the declared location and put all to head.
+      [:head, :footer].each do |location|
+        if hl.docinfo?(location)
+          tags << hl.docinfo(location, self, cdn_base_url: CDN_BASE_URI, linkcss: attr?(:linkcss))
+        end
+      end
+    end
+
     tags.join("\n")
   end
 
@@ -678,27 +712,21 @@ is book and it's a child of a book part. Excluding block content."
         text
       elsif (path = local_attr :path)
         path
-      elsif document.respond_to? :catalog  # Asciidoctor >=1.5.6
+      else
         ref = document.catalog[:refs][attr :refid]
         if ref.kind_of? Asciidoctor::AbstractNode
-          ref.xreftext((@_html5s_xrefstyle ||= document.attributes['xrefstyle']))
+          ref.xreftext(attr(:xrefstyle, nil, true))
         end
-      else  # Asciidoctor < 1.5.6
-        document.references[:ids][attr :refid || target]
       end
     (str || "[#{attr :refid}]").tr_s("\n", ' ')
   end
 
   # @return [String, nil] text of the bibref anchor, or +nil+ if not found.
   def bibref_text
-    if document.respond_to? :catalog  # Asciidoctor >=1.5.6
-      if ::Asciidoctor::VERSION[0] == '1'
-        text
-      else  # Asciidoctor >= 2.0.0
-        "[#{reftext || id}]"
-      end
-    else
-      "[#{target}]"
+    if ::Asciidoctor::VERSION[0] == '1'
+      text
+    else  # Asciidoctor >= 2.0.0
+      "[#{reftext || id}]"
     end
   end
 

data/data/templates/inline_anchor.html.slim

@@ -1,12 +1,10 @@
 - case type
 - when :xref
-  a href=target =xref_text
+  a href=target class=role =xref_text
 - when :ref
-  / "target" is for backward compat. with Asciidoctor <1.5.6
-  a id=(id || target) aria-hidden='true'
+  a id=id aria-hidden='true'
 - when :bibref
-  / "target" is for backward compat. with Asciidoctor <1.5.6
-  a id=(id || target) aria-hidden='true'
+  a id=id aria-hidden='true'
   =bibref_text
 - else
   a id=id class=role href=target target=(attr :window) rel=link_rel title=(attr :title) =text

data/data/templates/inline_button.html.slim

@@ -1 +1,2 @@
-b.button =text
+kbd.button
+  samp =text

data/data/templates/inline_kbd.html.slim

@@ -1,7 +1,7 @@
 - if (keys = attr 'keys').size == 1
-  kbd =keys.first
+  kbd.key =keys.first
 - else
   kbd.keyseq
     - keys.each_with_index do |key, idx|
       ="+" unless idx.zero?
-      kbd =key
+      kbd.key =key