asciidoctor-tabs 1.0.0.alpha.1 → 1.0.0.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 370d0b3ca4f09c79c9e427316a4caaebea3f00d1759767967d0ef97a9195748d
-  data.tar.gz: 6e6da5d865f2c664aad52cd5ae7806623fc125f73139bd774c2594fa5cee171c
+  metadata.gz: b3efce4ce7fa405dd4983609797c24e85e5ee768ff1e70ee3df4e702cd579d79
+  data.tar.gz: b7671c6c76d775c1e46850fd0464c45e9b4ef7f9478c478b5f8c13d9a2cebb02
 SHA512:
-  metadata.gz: 79f7f471c4ca7a4c240b8015fc4a160d802d73e898af80529cf5da51e9e5fbbb02e029d2786007bdd39aac2f10f686de6fd8fdec683dbea552bd9811f89505ba
-  data.tar.gz: b954ee1788718b5b63b4536555c7d5b51260108946d34200cc84a53cee2b64304a7d266effba6d0eaf485c862c820e26259fd005f3c018749c613994e46701ca
+  metadata.gz: 18b40647d4c424f1d9ce9749c7ca038342ae31ce4660ba4099b89cf9ca5a4c37540eb984384212f74f7b11b8987b9762847ff32710b2372a9bb3f186a720cd31
+  data.tar.gz: 21296914a580547da6f0703af319390351f9326a18ccc99b51719482fa6e73f2e466b6d2f9b0e99c673d7337aaf32faa8cc7a1d221f9b9bc5b6dc427b89bef34

data/CHANGELOG.adoc

@@ -4,6 +4,29 @@
 This document provides a curated view of the changes to Asciidoctor Tabs per release.
 For a detailed view of what has changed, refer to the {url-repo}/commits/main[commit history] on GitHub.
 
+== 1.0.0-alpha.2 (2022-10-03) - @mojavelinux
+
+=== Added
+
+* Transpile `Asciidoctor::Tabs::Extensions` class for npm package
+
+=== Changed
+
+* Rename `idx-tabset` counter to `tabset-number` to be consistent with built-in counter names
+* Don't register docinfo extensions if converter is producing embedded output
+* Update `register` and `unregister` on `Asciidoctor::Tabs::Extensions` to accept a registry argument
+* Delegate registration of extension in npm package to `Asciidoctor::Tabs::Extensions.register` method
+* Allow `Extensions` class to be required from `@asciidoctor/tabs/extensions` in Node.js; attach `Block` and `Docinfo` classes
+
+=== Fixed
+
+* Honor explicit ID on tabs block and use it as ID prefix for tabs
+* Autogenerate IDs for tabsets and tabs in a manner consistent with section ID generation (#2)
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.0-alpha.2[git tag] | {url-repo}/compare/v1.0.0-alpha.1\...v1.0.0-alpha.2[full diff]
+
 == 1.0.0-alpha.1 (2022-10-01) - @mojavelinux
 
 _Initial release._

data/README.adoc

@@ -1,11 +1,11 @@
 = Asciidoctor Tabs
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
-v1.0.0-alpha.1, 2022-10-01
+v1.0.0-alpha.2, 2022-10-03
 :idprefix:
 :idseparator: -
 
-An Asciidoctor extension that adds tabs to the AsciiDoc syntax.
-The tabset is constructed from a dlist enclosed in an example block marked with the tabs style.
+An Asciidoctor extension that adds a tabs block to the AsciiDoc syntax.
+Each set of tabs (a "tabset") is constructed from a dlist enclosed in an example block marked with the tabs style.
 This extension is only designed to be used with the `html` backend.
 
 == Install
@@ -41,7 +41,7 @@ Then use Bundler to install the gem:
 
 A tabset is defined using a dlist enclosed in an example block marked with the tabs style.
 Each item in the dlist becomes a separate tab.
-The term in the dlist item is used for the title of the tab.
+The term in the dlist item is used as the tab's label.
 The description in the dlist item is used for the contents of the tab.
 The contents can be defined as primary text, attached blocks, or blocks enclosed in an attached open block.
 If the blocks are enclosed in an attached open block, the open block enclosure itself will be discarded.

data/lib/asciidoctor/tabs/block.rb

@@ -6,16 +6,13 @@ module Asciidoctor
       use_dsl
       on_context :example
 
-      ID_SEPARATOR_CHAR = '-'
-      INVALID_ID_CHARS_RX = /[^a-zA-Z0-9_]/
-
       def process parent, reader, attrs
-        block = create_block parent, :example, nil, attrs, content_model: :compound
+        block = create_block parent, attrs['cloaked-context'], nil, attrs, content_model: :compound
         children = (parse_content block, reader).blocks
         return block unless children.size == 1 && (source_tabs = children[0]).context == :dlist && source_tabs.items?
         nodes = []
-        tabset_idx = parent.document.counter 'idx-tabset'
-        id = block.id || %(tabset#{tabset_idx})
+        tabset_number = (doc = parent.document).counter 'tabset-number'
+        id = attrs['id'] || %(#{doc.attributes['idprefix'] || '_'}tabset#{tabset_number})
         nodes << (create_html_fragment parent, %(<div id="#{id}" class="tabset is-loading">))
         tabs = create_list parent, :ulist
         tabs.add_role 'tabs'
@@ -23,7 +20,7 @@ module Asciidoctor
         source_tabs.items.each do |(title), details|
           tab = create_list_item tabs
           tabs << tab
-          tab_id = generate_id title.text, id
+          tab_id = generate_id title.text, id, doc
           tab.text = %([[#{tab_id}]]#{title.instance_variable_get :@text})
           if details.blocks?
             blocks = details.blocks
@@ -56,8 +53,12 @@ module Asciidoctor
         create_block parent, 'pass', html, nil
       end
 
-      def generate_id str, base_id
-        %(#{base_id}_#{str.downcase.gsub INVALID_ID_CHARS_RX, ID_SEPARATOR_CHAR})
+      def generate_id str, base_id, doc
+        restore_idprefix = (attrs = doc.attributes)['idprefix']
+        attrs['idprefix'] = %(#{base_id}#{attrs['idseparator'] || '_'})
+        ::Asciidoctor::Section.generate_id str, doc
+      ensure
+        restore_idprefix ? (attrs['idprefix'] = restore_idprefix) : (attrs.delete 'idprefix')
       end
     end
   end

data/lib/asciidoctor/tabs/extensions.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'block'
-require_relative 'docinfo'
+unless RUBY_ENGINE == 'opal'
+  require_relative 'block'
+  require_relative 'docinfo'
+end
 
 module Asciidoctor
   module Tabs
@@ -11,8 +13,10 @@ module Asciidoctor
       def group
         proc do
           block Block, :tabs
+          next if @document.embedded?
           docinfo_processor Docinfo::Styles
           docinfo_processor Docinfo::Behavior
+          nil
         end
       end
 
@@ -20,12 +24,13 @@ module Asciidoctor
         :tabs
       end
 
-      def register
-        ::Asciidoctor::Extensions.register key, &group
+      def register registry = nil
+        (registry || ::Asciidoctor::Extensions).groups[key] ||= group
       end
 
-      def unregister
-        ::Asciidoctor::Extensions.groups.delete key
+      def unregister registry = nil
+        (registry || ::Asciidoctor::Extensions).groups.delete key
+        nil
       end
     end
   end

data/lib/asciidoctor/tabs/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module Tabs
-    VERSION = '1.0.0.alpha.1'
+    VERSION = '1.0.0.alpha.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-tabs
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.1
+  version: 1.0.0.alpha.2
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-01 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor