asciidoctor-html 0.1.2 → 0.1.4

data/lib/asciidoctor/html/webmanifest.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Asciidoctor
+  module Html
+    # Generates the site.webmanifest for Android
+    module Webmanifest
+      def self.generate(name, short_name)
+        {
+          name:,
+          short_name:,
+          icons: %w[192x192 512x512].map do |sizes|
+            { src: "#{FAVICON_PATH}/android-chrome-#{sizes}.png", sizes:, type: "image/png" }
+          end,
+          theme_color: "#ffffff",
+          background_color: "#ffffff",
+          display: "standalone"
+        }.to_json
+      end
+    end
+  end
+end

data/lib/asciidoctor/html.rb

@@ -1,5 +1,17 @@
 # frozen_string_literal: true
 
-require_relative "html/version"
+module Asciidoctor
+  # Constants in the Html namespace
+  module Html
+    ASSETS_PATH = "assets"
+    FAVICON_PATH = "#{ASSETS_PATH}/favicon".freeze
+    CSS_PATH = "#{ASSETS_PATH}/css".freeze
+    IMG_PATH = "#{ASSETS_PATH}/img".freeze
+    SEARCH_PAGE = "search.html"
+  end
+end
+
 require_relative "html/converter"
 require_relative "html/ref_tree_processor"
+require_relative "html/book"
+require_relative "html/cli"

data/lib/minitest/html_plugin.rb

@@ -7,8 +7,9 @@ require "cgi"
 module Minitest
   # Custom reporter class that creates an HTML file in the docs folder
   class HTMLReporter < AbstractReporter
-    DOCS_DIR = "#{__dir__}/../../docs".freeze
+    DOCS_DIR = "#{__dir__}/../../docs/asciidoc".freeze
     TESTS_DIR = "#{__dir__}/../../test/asciidoctor/html".freeze
+    CONFIG_FILE = "#{DOCS_DIR}/config.yml".freeze
 
     def initialize
       @results = {}
@@ -19,27 +20,24 @@ module Minitest
       @results[result.name] = result.failures
     end
 
-    def display_failure(failure, color)
-      %(<pre class="border border-#{color}"><code class="language-shell">#{failure}</code></pre>\n)
+    def display_failure(failure)
+      %([source,shell,role="text-bg-danger"]\n----\n#{failure}\n----\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)
+    def display_result_title(name, failed, color)
+      status_icon = %(pass:[<i class="bi bi-#{failed ? "x" : "check"}-lg text-#{color}"></i>])
+      %(#{status_icon} #{name.tr("_", " ").capitalize})
     end
 
-    def display_result(name, adoc, html)
+    def display_result(name, adoc)
       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>)
+      title = display_result_title name, failed, color
+      pre = %([source,asciidoc]\n------\n#{adoc}\n------\n)
+      fail = failed ? display_failure(@results[key].join("\n")) : ""
+      %([##{id}]\n== #{title}\n\n#{pre}#{fail}\n\n#{adoc}\n\n)
     end
 
     def report_files(results, dirname)
@@ -47,21 +45,19 @@ module Minitest
         next unless filepath.extname == ".adoc"
 
         results << display_result(filepath.basename.sub_ext("").to_s,
-                                  File.read(filepath), File.read(filepath.sub_ext(".html")))
+                                  File.read(filepath))
       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)
+      time = %([.lead]\n#{Time.now.strftime("%d/%m/%Y %H:%M")}\n)
       results = []
-      Pathname(TESTS_DIR).children.sort.each do |pn|
-        next unless pn.directory?
-
+      Pathname(TESTS_DIR).children.reject { |f| f.file? || f.basename.to_s.start_with?("_") }.sort.each do |pn|
         report_files results, pn
       end
-      html = %(#{frontmatter}#{time}#{results.join "\n"})
-      File.write("#{DOCS_DIR}/index.html", html)
+      adoc = %(= Test Results\n\n#{time}\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: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Ravi Rajani
@@ -23,6 +23,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: roman-numerals
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +67,8 @@ dependencies:
         version: '0.3'
 email:
 - ravi.inajar@gmail.com
-executables: []
+executables:
+- adoctohtml
 extensions: []
 extra_rdoc_files: []
 files:
@@ -49,35 +78,32 @@ 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
+- assets/css/fonts/bootstrap-icons.woff
+- assets/css/fonts/bootstrap-icons.woff2
+- assets/css/styles.css
+- assets/css/styles.css.map
+- assets/favicon/android-chrome-192x192.png
+- assets/favicon/android-chrome-512x512.png
+- assets/favicon/apple-touch-icon.png
+- assets/favicon/favicon-16x16.png
+- assets/favicon/favicon-32x32.png
+- assets/favicon/favicon.ico
+- exe/adoctohtml
 - lib/asciidoctor/html.rb
+- lib/asciidoctor/html/bi_inline_macro.rb
+- lib/asciidoctor/html/book.rb
+- lib/asciidoctor/html/cli.rb
 - lib/asciidoctor/html/converter.rb
+- lib/asciidoctor/html/cref_inline_macro.rb
 - lib/asciidoctor/html/figure.rb
-- lib/asciidoctor/html/olist.rb
+- lib/asciidoctor/html/highlightjs.rb
+- lib/asciidoctor/html/list.rb
+- lib/asciidoctor/html/popovers.rb
 - lib/asciidoctor/html/ref_tree_processor.rb
+- lib/asciidoctor/html/template.rb
 - lib/asciidoctor/html/tree_walker.rb
 - lib/asciidoctor/html/utils.rb
-- lib/asciidoctor/html/version.rb
+- lib/asciidoctor/html/webmanifest.rb
 - lib/minitest/html_plugin.rb
 homepage: https://github.com/ravirajani/asciidoctor-html
 licenses:
@@ -103,6 +129,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: An alternative HTML converter for Asciidoctor and a Jekyll-based script to
-  generate a book.
+summary: An AsciiDoc-to-HTML static site generator based on Asciidoctor.
 test_files: []

data/docs/_config.yml

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

data/docs/_layouts/default.html

@@ -1,25 +0,0 @@
-<!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

@@ -1,35 +0,0 @@
-$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

@@ -1,30 +0,0 @@
-.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

@@ -1,17 +0,0 @@
-.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

@@ -1,101 +0,0 @@
-.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

@@ -1,40 +0,0 @@
-// 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

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

data/docs/assets/css/styles.scss

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

data/docs/package-lock.json

@@ -1,59 +0,0 @@
-{
-  "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

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

data/docs/site.webmanifest

@@ -1 +0,0 @@
-{"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/olist.rb

@@ -1,18 +0,0 @@
-# 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/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Asciidoctor
-  module Html
-    VERSION = "0.1.2"
-  end
-end