asciidoctor-html 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb08661857ac0a38bcb97d0f4eefc5d155f8f60ab720eb80d0ca5c0da82eab59
-  data.tar.gz: bb88cc92bcfc63edbc90bca406cad9818a577a13ea4722740364b96c5843fa70
+  metadata.gz: 2dfaf44dfed22e54fb5cac254f5dd1f18618cb40167bb2a506d2ba37ef381292
+  data.tar.gz: 5c9915bf539614fbcfdb8578009db076324c87e172a0871f4ee9383c68aed4f3
 SHA512:
-  metadata.gz: e1e5f386607dea80a054782df8e20a7e5d2f35d1b5c94b0504a4df50d8c66f61d652d3555e1d2b5ddaecccf44a545adf235995426bf644d76677aa63136d016d
-  data.tar.gz: 055f53673e99b88002a51381aa2b4730c3664d8d74cf9caadcf0fedfc3d3e23d013dc8a8fa5b2a66a25fcaf79e262b86fd1d8d727a4dd40ea908d6248981816b
+  metadata.gz: fe41726063320cc979c2ed2e117726ac8543dfde3337fd6fa9600a671c37bdcb25891b431147db21cf6d22121e9531f7d9fead0ddc246c430cce754acbbd52fd
+  data.tar.gz: b3c63eb1f916812247b58f9f397dd316149e2625e49fe23869137a7eb920cba0f0a34e966102984168f13695940b36657a4b41354069c62e176dda0c7358a0e9

data/.rubocop.yml

@@ -2,6 +2,24 @@ AllCops:
   TargetRubyVersion: 3.1
   NewCops: enable
 
+Metrics/AbcSize:
+  Max: 40
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/PerceivedComplexity:
+  Max: 20
+
+Metrics/BlockNesting:
+  Max: 5
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/ClassLength:
+  Max: 200
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 

data/CHANGELOG.md

@@ -3,3 +3,9 @@
 ## [0.1.0] - 2025-06-09
 
 - Initial release
+
+## [0.1.1] - 2025-06-29
+
+- Add custom olist conversion.
+- Automatic processing of reftexts based on block numbering scheme.
+- Automatic processing of anchor reftexts based on list item labels.

data/README.md

@@ -1,21 +1,23 @@
+[![Build](https://github.com/ravirajani/asciidoctor-html/actions/workflows/main.yml/badge.svg)](https://github.com/ravirajani/asciidoctor-html/actions/workflows/main.yml)
+
 # Asciidoctor::Html
 
-This gem provides an alternative HTML converter for [Asciidoctor](https://github.com/asciidoctor/asciidoctor).
+**The code in this repo is being actively developed and currently has limited functionality.**
 
-## Installation
+When complete, this gem will provide an alternative HTML converter for [Asciidoctor](https://github.com/asciidoctor/asciidoctor) as well as Jekyll-based book generator.
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add asciidoctor-html
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install asciidoctor-html
 ```
 
 ## Usage
@@ -33,14 +35,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/asciidoctor-html. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/asciidoctor-html/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Asciidoctor::Html project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/asciidoctor-html/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+require "jekyll"
 require "minitest/test_task"
 
 Minitest::TestTask.create
@@ -9,4 +10,13 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
+task build: %i[test rubocop] do
+  config = Jekyll.configuration({
+                                  source: "./docs",
+                                  destination: "./_site"
+                                })
+  site = Jekyll::Site.new(config)
+  Jekyll::Commands::Build.build site, config
+end
+
 task default: %i[test rubocop]

data/docs/_config.yml

@@ -0,0 +1,5 @@
+title: asciidoctor-html docs
+  
+exclude:
+  - package.json
+  - package-lock.json

data/docs/_layouts/default.html

@@ -0,0 +1,25 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>{{ page.title }} | {{ site.title }}</title>
+    <link rel="apple-touch-icon" sizes="180x180" href="apple-touch-icon.png">
+    <link rel="icon" type="image/png" sizes="32x32" href="favicon-32x32.png">
+    <link rel="icon" type="image/png" sizes="16x16" href="favicon-16x16.png">
+    <link rel="manifest" href="site.webmanifest">
+    <link rel="stylesheet" href="assets/css/styles.css">
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.11.1/build/styles/default.min.css">
+    <script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.11.1/build/highlight.min.js"></script>
+    <script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
+    </head>
+  <body>
+    <main class="content-container">
+      <h1 class="display-4">{{ page.title }}</h1>
+      {{ content }}
+    </main>
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.6/dist/js/bootstrap.bundle.min.js" integrity="sha384-j1CDi7MgGQ12Z7Qab0qlWQ/Qqz24Gc6BM0thvEMVjHnfYGF0rmFCozFSxQBxwHKO" crossorigin="anonymous"></script>
+    <script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.11.1/build/languages/asciidoc.min.js"></script>
+    <script>hljs.highlightAll();</script>
+  </body>
+</html>

data/docs/_sass/_custom.scss

@@ -0,0 +1,35 @@
+$content-padding-x: 0.75rem;
+$content-padding-y: 0.5rem;
+$content-width: 90rch;
+
+main {
+    margin: $spacer auto;
+}
+
+.full-width-bg {
+    padding-left: $content-padding-x;
+    padding-right: $content-padding-x;
+    margin-left: -$content-padding-x;
+    margin-right: -$content-padding-x;
+}
+
+.content-container {
+    max-width: $content-width;
+    padding-left: $content-padding-x;
+    padding-right: $content-padding-x;
+}
+
+.title-mark {
+    margin-right: 1.5ex;
+}
+
+.title-prefix {
+    margin-right: 1ex;
+    &::after {
+        content: ':';
+    }
+}
+
+.block-title {
+    margin-bottom: 0.25rem;
+}

data/docs/_sass/_example.scss

@@ -0,0 +1,30 @@
+.example {
+    @extend .full-width-bg;
+    padding-top: $content-padding-y;
+    padding-bottom: $content-padding-y;
+    margin-bottom: $spacer;
+    border-top: 2px solid var(--example-border-color, var(--bs-secondary-border-subtle));
+    border-bottom: 2px solid var(--example-border-color, var(--bs-secondary-border-subtle));
+    background-color: var(--example-bg-color, var(--bs-secondary-bg-subtle));
+    > *:last-child {
+        margin-bottom: 0;
+    }
+}
+
+$thm-types: theorem, proposition, lemma, corollary;
+
+@each $type in $thm-types {
+    .example-#{$type} {
+        --example-border-color: var(--bs-primary-border-subtle);
+        --example-bg-color: var(--bs-primary-bg-subtle);
+    }
+}
+
+.example-algorithm {
+    --example-border-color: #{tint-color($orange, 60%)};
+    --example-bg-color: #{tint-color($orange, 80%)};
+    @include color-mode(dark) {
+        --example-border-color: #{shade-color($orange, 40%)};
+        --example-bg-color: #{shade-color($orange, 80%)};
+    }
+}

data/docs/_sass/_figure.scss

@@ -0,0 +1,17 @@
+.figbox {
+    margin: 1.5rem -#{$content-padding-x};
+}
+figure {
+    text-align: center;
+    img {
+        @extend .figure-img;
+        @extend .img-fluid;
+        max-height: 400px;
+    }
+    figcaption {
+        padding-left: $content-padding-x;
+        padding-right: $content-padding-x;
+        text-align: center;
+        @extend .figure-caption;
+    }
+}

data/docs/_sass/_olist.scss

@@ -0,0 +1,101 @@
+.arabic, .lowerroman {
+    > li .li-mark::after {
+        content: '.';
+    }
+}
+.loweralpha, .upperalpha {
+    > li .li-mark {
+        &::before { content: '('; }
+        &::after { content: ')'; }
+    }
+}
+
+.list-wrapper {
+    margin-bottom: $spacer;
+    ol, ul {
+        margin-bottom: 0;
+    }
+}
+
+.olist {
+    @extend .list-unstyled;
+    li {
+        display: flex;
+        flex-flow: row nowrap;
+        gap: 0.5rem;
+        align-items: first baseline;
+        .li-mark {
+            flex: 0 0 1.5rem;
+            text-align: right;
+        }
+        .li-content {
+            flex: 1;
+            p { margin-bottom: 0.25rem; }
+        }
+    }
+    &.pseudocode {
+        @mixin pcode-style($initial-gap, $indent) {
+            $mark-width: 1.25rem;
+            > li {
+                gap: $initial-gap;
+                > .li-mark {
+                    flex: 0 0 $mark-width;
+                }
+            }
+            @for $i from 1 through 3 {
+                &.level-#{$i + 1} {
+                    margin-left: -($i - 1)*$indent - $initial-gap - $mark-width;
+                    > li {
+                        gap: $i*$indent + $initial-gap;
+                    }
+                }
+            }
+        }
+
+        @include pcode-style($initial-gap: 0.75rem, $indent: 1.5rem);
+
+        @include media-breakpoint-up(sm) {
+            @include pcode-style($initial-gap: 0.75rem, $indent: 1.75rem);
+        }
+
+        @include media-breakpoint-up(md) {
+            @include pcode-style($initial-gap: 1rem, $indent: 2rem);
+        }
+
+        .li-mark {
+            font-size: 90%;
+            color: var(--bs-tertiary-color);
+        }
+    }
+}
+
+.figlist-wrapper {
+    @extend .figbox;
+    .figlist {
+        margin-bottom: 0;
+        @extend .list-unstyled;
+        display: flex;
+        flex-flow: row wrap;
+        gap: 0.75rem;
+        justify-content: space-evenly;
+        align-items: last baseline;
+        li {
+            flex: 1;
+            .li-mark {
+                margin-right: 1ex;
+            }
+            figure {
+                margin-bottom: 0.25rem;
+                img {
+                    min-width: 300px;
+                }
+            }
+        }
+    }
+    .block-title {
+        padding-left: $content-padding-x;
+        padding-right: $content-padding-x;
+        text-align: center;
+        @extend .figure-caption;
+    }
+}

data/docs/_sass/main.scss

@@ -0,0 +1,40 @@
+// main.scss
+
+// 1. Include functions first (so you can manipulate colors, SVGs, calc, etc)
+@import "../node_modules/bootstrap/scss/functions";
+
+// 2. Include any default variable overrides here
+$color-mode-type: media-query;
+
+// 3. Include remainder of required Bootstrap stylesheets (including any separate color mode stylesheets)
+@import "../node_modules/bootstrap/scss/variables";
+@import "../node_modules/bootstrap/scss/variables-dark";
+
+// 4. Include any default map overrides here
+
+// 5. Include remainder of required parts
+@import "../node_modules/bootstrap/scss/maps";
+@import "../node_modules/bootstrap/scss/mixins";
+@import "../node_modules/bootstrap/scss/root";
+
+// 6. Include any other optional stylesheet partials as desired; list below is not inclusive of all available stylesheets
+@import "../node_modules/bootstrap/scss/utilities";
+@import "../node_modules/bootstrap/scss/reboot";
+@import "../node_modules/bootstrap/scss/type";
+@import "../node_modules/bootstrap/scss/images";
+@import "../node_modules/bootstrap/scss/containers";
+@import "../node_modules/bootstrap/scss/grid";
+@import "../node_modules/bootstrap/scss/helpers";
+@import "../node_modules/bootstrap/scss/buttons";
+@import "../node_modules/bootstrap/scss/transitions";
+// ...
+
+// 7. Optionally include utilities API last to generate classes based on the Sass map in `_utilities.scss`
+@import "../node_modules/bootstrap/scss/utilities/api";
+
+// 8. Add additional custom code here
+@import "../node_modules/bootstrap-icons/font/bootstrap-icons";
+@import "custom";
+@import "example";
+@import "olist";
+@import "figure";

data/docs/assets/css/fonts

@@ -0,0 +1 @@
+../../node_modules/bootstrap-icons/font/fonts

data/docs/assets/css/styles.scss

@@ -0,0 +1,3 @@
+---
+---
+@import "main";

data/docs/package-lock.json

@@ -0,0 +1,59 @@
+{
+  "name": "docs",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "dependencies": {
+        "bootstrap": "^5.3.6",
+        "bootstrap-icons": "^1.13.1"
+      }
+    },
+    "node_modules/@popperjs/core": {
+      "version": "2.11.8",
+      "resolved": "https://registry.npmjs.org/@popperjs/core/-/core-2.11.8.tgz",
+      "integrity": "sha512-P1st0aksCrn9sGZhp8GMYwBnQsbvAWsZAX44oXNNvLHGqAOcoVxmjZiohstwQ7SqKnbR47akdNi+uleWD8+g6A==",
+      "license": "MIT",
+      "peer": true,
+      "funding": {
+        "type": "opencollective",
+        "url": "https://opencollective.com/popperjs"
+      }
+    },
+    "node_modules/bootstrap": {
+      "version": "5.3.6",
+      "resolved": "https://registry.npmjs.org/bootstrap/-/bootstrap-5.3.6.tgz",
+      "integrity": "sha512-jX0GAcRzvdwISuvArXn3m7KZscWWFAf1MKBcnzaN02qWMb3jpMoUX4/qgeiGzqyIb4ojulRzs89UCUmGcFSzTA==",
+      "funding": [
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/twbs"
+        },
+        {
+          "type": "opencollective",
+          "url": "https://opencollective.com/bootstrap"
+        }
+      ],
+      "license": "MIT",
+      "peerDependencies": {
+        "@popperjs/core": "^2.11.8"
+      }
+    },
+    "node_modules/bootstrap-icons": {
+      "version": "1.13.1",
+      "resolved": "https://registry.npmjs.org/bootstrap-icons/-/bootstrap-icons-1.13.1.tgz",
+      "integrity": "sha512-ijombt4v6bv5CLeXvRWKy7CuM3TRTuPEuGaGKvTV5cz65rQSY8RQ2JcHt6b90cBBAC7s8fsf2EkQDldzCoXUjw==",
+      "funding": [
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/twbs"
+        },
+        {
+          "type": "opencollective",
+          "url": "https://opencollective.com/bootstrap"
+        }
+      ],
+      "license": "MIT"
+    }
+  }
+}

data/docs/package.json

@@ -0,0 +1,6 @@
+{
+  "dependencies": {
+    "bootstrap": "^5.3.6",
+    "bootstrap-icons": "^1.13.1"
+  }
+}

data/docs/site.webmanifest

@@ -0,0 +1 @@
+{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}

data/lib/asciidoctor/html/converter.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require "asciidoctor"
+require_relative "olist"
 require_relative "utils"
+require_relative "figure"
 
 module Asciidoctor
   module Html
@@ -9,26 +11,61 @@ module Asciidoctor
     class Converter < (Asciidoctor::Converter.for "html5")
       register_for "html5"
 
+      include Figure
+
       def convert_section(node)
-        doc_attrs = node.document.attributes
+        document = node.document
         level = node.level
-        show_sectnum = node.numbered && level <= (doc_attrs["sectnumlevels"] || 3).to_i
-        tag_name = %(h#{level + 1})
-        sectnum = show_sectnum ? %(<span class="sec-mark">#{node.sectnum ""}</span>) : ""
-        content = %(<#{tag_name}#{Utils.id_class_attr_str nil, node.role}>) +
-                  %(#{sectnum}#{node.title}</#{tag_name}>\n\n#{node.content})
+        show_sectnum = node.numbered && level <= (document.attr("sectnumlevels") || 1).to_i
+        tag_name = %(h#{[level + 2, 6].min})
+        sectnum = show_sectnum ? %(<span class="title-mark">#{node.sectnum ""}</span>) : ""
+        content = %(<#{tag_name}>#{sectnum}#{node.title}) +
+                  %(</#{tag_name}>\n#{node.content})
         Utils.wrap_node content, node, :section
       end
 
       def convert_paragraph(node)
-        content = %(#{Utils.display_title node}<p>#{node.content}</p>)
-        node.title? ? Utils.wrap_node(content, node) : "#{content}\n"
+        content = %(<p>#{node.content}</p>\n)
+        Utils.wrap_node_with_title content, node
       end
 
       def convert_example(node)
-        node.set_attr "reftext", Utils.title_prefix(node)
-        content = Utils.display_title(node) + node.content
-        Utils.wrap_node content, node
+        p node.context unless Utils.show_title?(node)
+        Utils.wrap_node_with_title node.content, node, needs_prefix: true
+      end
+
+      def convert_image(node)
+        return super if node.option?("inline") || node.option?("interactive")
+
+        content = display_figure node
+        Utils.wrap_id_classes content, node.id, ["figbox", node.role].compact.join(" ")
+      end
+
+      def convert_inline_image(node)
+        return super if node.option?("inline") || node.option?("interactive")
+
+        target = node.target
+        mark = node.parent.attr("mark")
+        attrs = image_attrs node
+        image = display_image node, target, attrs
+        title = node.attr?("title") ? node.attr("title") : ""
+        caption = mark ? %(<span class="li-mark">#{mark}</span>#{title}) : title
+        %(    #{image}\n    <figcaption>#{caption}</figcaption>)
+      end
+
+      def convert_olist(node)
+        return convert_figlist(node) if node.style == "figlist"
+
+        depth = node.attr "list-depth"
+        flat = node.attr? "flat-style"
+        level = depth + 1
+        classes = ["olist level-#{level}", flat ? "pseudocode" : node.style, node.role].compact.join(" ")
+        result = [%(<ol#{Utils.dyn_id_class_attr_str node, classes}>)]
+        node.items.each do |item|
+          result << Olist.display_list_item(item)
+        end
+        result << %(</ol> <!-- .level-#{level} -->\n)
+        Utils.wrap_id_classes_with_title result.join("\n"), node, node.id, "list-wrapper"
       end
     end
   end

data/lib/asciidoctor/html/figure.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "olist"
+
+module Asciidoctor
+  module Html
+    # Helper functions for the image/figure conversion.
+    # Mixed into the Converter class.
+    module Figure
+      def display_image(node, target, attrs)
+        %(<img src="#{node.image_uri target}" #{attrs}#{@void_element_slash}>)
+      end
+
+      def image_attrs(node)
+        width = node.attr?("width") ? %( width="#{node.attr "width"}") : ""
+        height = node.attr?("height") ? %( height="#{node.attr "height"}") : ""
+        alt = encode_attribute_value node.alt
+        %(alt="#{alt}"#{width}#{height})
+      end
+
+      def display_figure(node)
+        target = node.attr "target"
+        title = node.title? ? node.title : ""
+        attrs = image_attrs node
+        image = display_image node, target, attrs
+        caption = %(<figcaption>#{Utils.display_title_prefix node}#{title}</figcaption>)
+        %(<figure>\n    #{image}\n    #{caption}\n</figure>)
+      end
+
+      def convert_figlist(node)
+        result = node.items.map do |item|
+          %(<li#{Utils.id_class_attr_str item.id}><figure>\n#{item.text}\n</figure></li>)
+        end
+        content = Utils.wrap_id_classes result.join("\n"), nil, "figlist loweralpha", :ol
+        title = Utils.display_title node
+        classes = ["figlist-wrapper", node.role].compact.join(" ")
+        Utils.wrap_id_classes %(#{content}#{title}), node.id, classes
+      end
+    end
+  end
+end

data/lib/asciidoctor/html/olist.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  module Html
+    # Helper functions for the olist conversion.
+    module Olist
+      def self.display_list_item(item)
+        result = []
+        result << %(<li#{Utils.id_class_attr_str item.id,
+                                                 item.role}><div class="li-mark">#{item.attr "mark"}</div>)
+        result << %(<div class="li-content"><p>#{item.text}</p>)
+        result << "\n#{item.content}" if item.blocks?
+        result << %(</div></li>#{Utils.id_class_sel_comment item.id, item.role})
+        result.join "\n"
+      end
+    end
+  end
+end

data/lib/asciidoctor/html/ref_tree_processor.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require "roman-numerals"
+require_relative "tree_walker"
+
+module Asciidoctor
+  module Html
+    # Traverses the document tree and attaches a correct reftext to
+    # numbered nodes.
+    class RefTreeProcessor < Asciidoctor::Extensions::TreeProcessor
+      NUMBERED_CONTEXTS = {
+        example: "thm-number",
+        table: "tbl-number",
+        image: "fig-number"
+      }.freeze
+
+      def number_within(document)
+        return :chapter if document.attr? "chapnum"
+        return :section if document.attr? "sectnums"
+
+        :document
+      end
+
+      def assign_numeral!(node, document, counter_name)
+        document.counters[counter_name] ||= 0
+        node.numeral = (document.counters[counter_name] += 1)
+      end
+
+      def relative_numeral(node, document, sectnum)
+        if node.numeral
+          prefix_number = (document.attr("chapnum") || sectnum).to_i
+          prefix_number.positive? ? "#{prefix_number}.#{node.numeral}" : node.numeral.to_s
+        else
+          ""
+        end
+      end
+
+      def process_numbered_block!(block, document, sectnum)
+        context = block.context
+        env = (block.style || context).to_s
+        env = "figure" if context == :image || env == "figlist"
+        block.set_attr "showcaption", true
+        assign_numeral! block, document, NUMBERED_CONTEXTS[context]
+        title_prefix = "#{env.capitalize} #{relative_numeral block, document, sectnum}"
+        block.set_attr "reftext", title_prefix
+      end
+
+      def process_numbered_block?(block)
+        NUMBERED_CONTEXTS.key?(block.context) || block.style == "figlist"
+      end
+
+      def li_mark(depth, idx)
+        case depth
+        when 0
+          idx + 1
+        when 1
+          ("a".."z").to_a[idx]
+        when 2
+          RomanNumerals.to_roman(idx + 1).downcase
+        when 3
+          ("a".."z").to_a[idx].upcase
+        end
+      end
+
+      def ref_li_mark(mark, depth)
+        return mark.to_s if depth.even?
+
+        "(#{mark})"
+      end
+
+      def offset(list)
+        list.attr?("start") ? (list.attr("start").to_i - 1) : 0
+      end
+
+      def register_reftext!(document, anchor_id, reftext)
+        node = document.catalog[:refs][anchor_id]
+        node&.text = reftext
+      end
+
+      def process_olist!(block, depth, flat_style: false)
+        parent_reftext = ""
+        document = block.document
+        if depth.positive?
+          parent = block.parent
+          parent = parent.parent until parent.context == :list_item
+          parent_reftext = parent.reftext? ? parent.reftext : ""
+        end
+        block.set_attr "list-depth", depth
+        if flat_style
+          block.set_attr("flat-style", true)
+        else
+          offset = offset block
+          block.items.each_with_index do |item, idx|
+            d = block.style == "figlist" ? 1 : depth
+            mark = li_mark(d, idx + offset)
+            item.set_attr "mark", mark
+            item_reftext = "#{parent_reftext}#{ref_li_mark mark, d}"
+            item.set_attr "reftext", item_reftext
+            /^<a id="(?<id>.+?)"/ =~ item.text
+            register_reftext! document, id, item_reftext if id
+          end
+        end
+      end
+
+      def process_flat_item!(item, idx)
+        mark = li_mark(0, idx)
+        item.set_attr "mark", mark
+        item.set_attr "reftext", ref_li_mark(mark, 0)
+      end
+
+      def reset_counters!(document)
+        counters = document.counters
+        NUMBERED_CONTEXTS.each_value do |counter_name|
+          counters[counter_name] = 0
+        end
+      end
+
+      def process(document)
+        sectnum = 0
+        listdepth = 0
+        flat_style = false
+        flat_idx = 0 # flat index for (pseudocode) list
+        tw = TreeWalker.new(document)
+        while (block = tw.next_block)
+          context = block.context
+          unless block.attr? "refprocessed"
+            process_numbered_block!(block, document, sectnum) if process_numbered_block?(block)
+            if context == :section && block.level == 1 && number_within(document) == :section
+              sectnum += 1
+              reset_counters! document
+            elsif context == :olist
+              if listdepth.zero?
+                flat_style = (block.style == "pseudocode")
+                flat_idx = offset block
+              end
+              process_olist!(block, listdepth, flat_style:)
+            elsif context == :list_item && flat_style
+              process_flat_item!(block, flat_idx)
+              flat_idx += 1
+            end
+            block.set_attr "refprocessed", true
+          end
+          tw.walk do |move|
+            listdepth += 1 if context == :olist && move == :explore
+            listdepth -= 1 if context == :list_item && move == :retreat
+          end
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/html/tree_walker.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  module Html
+    # Walks the document tree
+    class TreeWalker
+      def initialize(document, max_levels = 20)
+        @max_levels = max_levels
+        @idx = [0] * (max_levels + 1) # index of next unexplored block at each level
+        @path = [document]
+        @level = 0 # the current level
+      end
+
+      def next_block
+        return nil if @path.empty?
+
+        @path.last
+      end
+
+      def walk(&callback)
+        block = next_block
+        return nil unless block
+
+        if block.blocks? && @level < @max_levels && @idx[@level + 1] < block.blocks.size
+          @level += 1
+          @path.push(block.blocks[@idx[@level]])
+          callback.call(:explore)
+        else
+          @idx[@level + 1] = 0 if @level < @max_levels
+          @idx[@level] += 1
+          @level -= 1
+          @path.pop
+          callback.call(:retreat)
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/html/utils.rb

@@ -10,45 +10,61 @@ module Asciidoctor
         "#{id_attr}#{class_attr}"
       end
 
+      # Don't include an id if the element will be wrapped
+      # by a title, since the wrapper should have the id.
+      def self.dyn_id_class_attr_str(node, classes = nil)
+        id = node.title? ? nil : node.id
+        id_class_attr_str id, classes
+      end
+
       def self.id_class_sel_str(id, classes)
         result = ""
         result += "##{id}" if id
         result + ".#{classes.tr "\s", "."}" if classes
       end
 
-      def self.display_number(node)
-        if node.numeral
-          chapter_number = node.document.attr("chapnum")
-          chapter_number ? "#{chapter_number}.#{node.numeral}" : node.numeral.to_s
-        else
-          ""
-        end
+      def self.id_class_sel_comment(id, classes)
+        id || (classes && !classes.empty?) ? " <!-- #{id_class_sel_str id, classes} -->" : ""
       end
 
-      def self.display_title(node)
-        prefix = display_title_prefix node
-        title = prefix.empty? ? node.title : %(<span class="title-content">#{node.title}</span>)
-        node.title? ? %(<h5 class="block-title">#{prefix}#{title}</h5>\n) : ""
+      def self.show_title?(node)
+        node.attr?("showcaption") || node.title?
       end
 
-      def self.title_prefix(node)
-        (node.style ? "#{node.style.capitalize} " : "") + display_number(node)
+      def self.display_title(node, needs_prefix: true)
+        prefix = needs_prefix ? display_title_prefix(node) : ""
+        show_title?(node) ? %(<h6 class="block-title">#{prefix}#{node.title}</h6>\n) : ""
       end
 
       def self.display_title_prefix(node)
-        prefix = title_prefix node
-        prefix.empty? ? "" : %(<span class="title-prefix">#{prefix}</span>)
+        prefix = node.reftext? ? node.reftext : ""
+        node.title? && !node.title.empty? ? %(<span class="title-prefix">#{prefix}</span>) : prefix
       end
 
       def self.wrap_id_classes(content, id, classes, tag_name = :div)
         id_class = id_class_attr_str id, classes
-        %(<#{tag_name}#{id_class}>\n#{content}\n</#{tag_name}> <!-- #{id_class_sel_str id, classes} -->\n)
+        %(<#{tag_name}#{id_class}>\n#{content}\n</#{tag_name}>#{id_class_sel_comment id, classes}\n)
       end
 
       def self.wrap_node(content, node, tag_name = :div)
-        classes = [node.context, node.style, node.role].compact.join " "
+        base_class = node.context
+        mod = node.attr?("env") ? node.attr("env") : node.style
+        mod_class = if mod && mod != base_class.to_s
+                      "#{base_class}-#{mod}"
+                    else
+                      ""
+                    end
+        classes = [base_class, mod_class, node.role].compact.map(&:to_s).uniq.join(" ").strip
         wrap_id_classes content, node.id, classes, tag_name
       end
+
+      def self.wrap_node_with_title(content, node, tag_name = :div, needs_prefix: false)
+        show_title?(node) ? wrap_node(display_title(node, needs_prefix:) + content, node, tag_name) : content
+      end
+
+      def self.wrap_id_classes_with_title(content, node, id, classes, needs_prefix: false)
+        show_title?(node) ? wrap_id_classes(display_title(node, needs_prefix:) + content, id, classes) : content
+      end
     end
   end
 end

data/lib/asciidoctor/html/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module Html
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/asciidoctor/html.rb

@@ -2,3 +2,4 @@
 
 require_relative "html/version"
 require_relative "html/converter"
+require_relative "html/ref_tree_processor"

data/lib/minitest/html_plugin.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "cgi"
+
+# Add class to Minitest module
+module Minitest
+  # Custom reporter class that creates an HTML file in the docs folder
+  class HTMLReporter < AbstractReporter
+    DOCS_DIR = "#{__dir__}/../../docs".freeze
+    TESTS_DIR = "#{__dir__}/../../test/asciidoctor/html".freeze
+
+    def initialize
+      @results = {}
+      super
+    end
+
+    def record(result)
+      @results[result.name] = result.failures
+    end
+
+    def display_failure(failure, color)
+      %(<pre class="border border-#{color}"><code class="language-shell">#{failure}</code></pre>\n)
+    end
+
+    def display_result_title(name, id, failed, color)
+      style = %(style="vertical-align: -0.125em;")
+      status_icon = %(<i class="bi bi-#{failed ? "x" : "check"}-square text-#{color}" #{style}></i>)
+      chevron = %(<i class="bi bi-chevron-expand"></i>)
+      attrs = %(type="button" data-bs-toggle="collapse" data-bs-target="##{id}")
+      %(#{status_icon}<button #{attrs} class="btn btn-link">#{chevron} #{name.tr("_", " ").capitalize}</button>\n)
+    end
+
+    def display_result(name, adoc, html)
+      key = "test_#{name}"
+      failed = @results[key]&.size&.positive?
+      color = failed ? "danger" : "success"
+      id = "test-#{name.tr "_", "-"}"
+      title = display_result_title name, id, failed, color
+      pre = %(<pre><code class="language-asciidoc">#{CGI.escapeHTML adoc}</code></pre>\n)
+      fail = failed ? display_failure(CGI.escapeHTML(@results[key].join("\n")), color) : ""
+      %(<div>#{title}<div class="collapse full-width-bg" id="#{id}">#{pre}#{fail}#{html}</div></div>)
+    end
+
+    def report_files(results, dirname)
+      dirname.children.sort.each do |filepath|
+        next unless filepath.extname == ".adoc"
+
+        results << display_result(filepath.basename.sub_ext("").to_s,
+                                  File.read(filepath), File.read(filepath.sub_ext(".html")))
+      end
+    end
+
+    def report
+      frontmatter = %(---\nlayout: default\ntitle: Test Results\n---\n)
+      time = %(<p class="lead">#{Time.now.strftime("%d/%m/%Y %H:%M")}</p>\n)
+      results = []
+      Pathname(TESTS_DIR).children.sort.each do |pn|
+        next unless pn.directory?
+
+        report_files results, pn
+      end
+      html = %(#{frontmatter}#{time}#{results.join "\n"})
+      File.write("#{DOCS_DIR}/index.html", html)
+    end
+  end
+
+  def self.plugin_html_init(_options)
+    reporter << HTMLReporter.new
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-html
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ravi Rajani
@@ -23,6 +23,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: roman-numerals
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 email:
 - ravi.inajar@gmail.com
 executables: []
@@ -35,10 +49,36 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- docs/_config.yml
+- docs/_layouts/default.html
+- docs/_sass/_custom.scss
+- docs/_sass/_example.scss
+- docs/_sass/_figure.scss
+- docs/_sass/_olist.scss
+- docs/_sass/main.scss
+- docs/android-chrome-192x192.png
+- docs/android-chrome-512x512.png
+- docs/apple-touch-icon.png
+- docs/assets/css/fonts
+- docs/assets/css/styles.scss
+- docs/assets/img/cat1.jpg
+- docs/assets/img/cat2.jpg
+- docs/assets/img/cat3.jpg
+- docs/favicon-16x16.png
+- docs/favicon-32x32.png
+- docs/favicon.ico
+- docs/package-lock.json
+- docs/package.json
+- docs/site.webmanifest
 - lib/asciidoctor/html.rb
 - lib/asciidoctor/html/converter.rb
+- lib/asciidoctor/html/figure.rb
+- lib/asciidoctor/html/olist.rb
+- lib/asciidoctor/html/ref_tree_processor.rb
+- lib/asciidoctor/html/tree_walker.rb
 - lib/asciidoctor/html/utils.rb
 - lib/asciidoctor/html/version.rb
+- lib/minitest/html_plugin.rb
 homepage: https://github.com/ravirajani/asciidoctor-html
 licenses:
 - MIT