asciidoctor-tabs 1.0.0.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 370d0b3ca4f09c79c9e427316a4caaebea3f00d1759767967d0ef97a9195748d
+  data.tar.gz: 6e6da5d865f2c664aad52cd5ae7806623fc125f73139bd774c2594fa5cee171c
+SHA512:
+  metadata.gz: 79f7f471c4ca7a4c240b8015fc4a160d802d73e898af80529cf5da51e9e5fbbb02e029d2786007bdd39aac2f10f686de6fd8fdec683dbea552bd9811f89505ba
+  data.tar.gz: b954ee1788718b5b63b4536555c7d5b51260108946d34200cc84a53cee2b64304a7d266effba6d0eaf485c862c820e26259fd005f3c018749c613994e46701ca

data/CHANGELOG.adoc

@@ -0,0 +1,13 @@
+= Asciidoctor Tabs Changelog
+:url-repo: https://github.com/asciidoctor/asciidoctor-tabs
+
+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.1 (2022-10-01) - @mojavelinux
+
+_Initial release._
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.0-alpha.1[git tag]

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) 2022-present Dan Allen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.adoc

@@ -0,0 +1,87 @@
+= Asciidoctor Tabs
+Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
+v1.0.0-alpha.1, 2022-10-01
+: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.
+This extension is only designed to be used with the `html` backend.
+
+== Install
+
+=== Using gem command
+
+ $ gem install --prerelease asciidoctor-tabs
+
+=== Using Bundler
+
+Create a [.path]_Gemfile_ in your project:
+
+.Gemfile
+[,ruby]
+----
+source 'https://rubygems.org'
+
+gem 'asciidoctor-tabs'
+
+# or use the code directlly from GitHub
+# gem 'asciidoctor-tabs', github: 'asciidoctor/asciidoctor-pdf'
+----
+
+Then configure Bundler to install gems locally (optional):
+
+ $ bundle config --local path .bundle/gems
+
+Then use Bundler to install the gem:
+
+ $ bundle
+
+== Syntax
+
+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 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.
+
+.document-with-tabs.adoc
+[,asciidoc]
+----
+[tabs]
+====
+Tab A:: Contents of tab A.
+
+Tab B::
++
+Contents of tab B.
+
+Tab C::
++
+--
+Contents of tab C.
+
+Contains more than one block.
+--
+====
+----
+
+== Usage
+
+ $ asciidoctor -r asciidoctor-tabs document-with-tabs.adoc
+
+== Authors
+
+Asciidoctor Tabs was written by Dan Allen of OpenDevise Inc. and contributed to the Asciidoctor project.
+
+== Copyright and License
+
+Copyright (C) 2018-present Dan Allen (OpenDevise Inc.) and the individual contributors to this project.
+Use of this software is granted under the terms of the MIT License.
+
+See the link:LICENSE[LICENSE] for the full license text.
+
+== Trademarks
+
+AsciiDoc(R) is a trademark of the Eclipse Foundation, Inc.

data/asciidoctor-tabs.gemspec

@@ -0,0 +1,39 @@
+begin
+  require_relative 'lib/asciidoctor/tabs/version'
+rescue LoadError
+  require 'asciidoctor/tabs/version'
+end
+
+Gem::Specification.new do |s|
+  s.name = 'asciidoctor-tabs'
+  s.version = Asciidoctor::Tabs::VERSION
+  s.summary = 'An Asciidoctor extension that adds a tabs block to the AsciiDoc syntax.'
+  s.description = 'An Asciidoctor extension that adds a tabs block to the AsciiDoc syntax. The tabset is constructed from a dlist enclosed in an example block marked with the tabs style.'
+  s.authors = ['Dan Allen']
+  s.email = 'dan@opendevise.com'
+  s.homepage = 'https://asciidoctor.org'
+  s.license = 'MIT'
+  # NOTE required ruby version is informational only; it's not enforced since it can't be overridden and can cause builds to break
+  #s.required_ruby_version = '>= 2.7.0'
+  s.metadata = {
+    'bug_tracker_uri' => 'https://github.com/asciidoctor/asciidoctor-tabs/issues',
+    'changelog_uri' => 'https://github.com/asciidoctor/asciidoctor-tabs/blob/main/CHANGELOG.adoc',
+    'mailing_list_uri' => 'https://chat.asciidoctor.org',
+    'source_code_uri' => 'https://github.com/asciidoctor/asciidoctor-tabs'
+  }
+
+  # NOTE the logic to build the list of files is designed to produce a usable package even when the git command is not available
+  begin
+    files = (result = `git ls-files -z`.split ?\0).empty? ? Dir['**/*'] : result
+  rescue
+    files = Dir['**/*']
+  end
+  s.files = files.grep %r/^(?:(?:data|lib)\/.+|LICENSE|(?:CHANGELOG|README)\.adoc|#{s.name}\.gemspec)$/
+  s.executables = (files.grep %r/^bin\//).map {|f| File.basename f }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'asciidoctor', ['>= 2.0.0', '< 3.0.0']
+
+  s.add_development_dependency 'rake', '~> 13.0.0'
+  s.add_development_dependency 'rspec', '~> 3.11.0'
+end

data/data/css/tabs.css

@@ -0,0 +1,67 @@
+/*! Asciidoctor Tabs stylesheet | Copyright (c) 2018-present Dan Allen | MIT License */
+.tabs ul {
+  display: flex;
+  flex-wrap: wrap;
+  list-style: none;
+  margin: 0 -0.25em 0 0;
+  padding: 0;
+}
+
+.tabs li {
+  align-items: center;
+  border: 1px solid black;
+  border-bottom: 0;
+  cursor: pointer;
+  display: flex;
+  font-weight: bold;
+  height: 2em;
+  line-height: 1;
+  margin-right: 0.25em;
+  padding: 0 1em;
+  position: relative;
+}
+
+.tabs.ulist li, .tabs.ulist p {
+  margin-bottom: 0;
+}
+
+.tabs li + li {
+  margin-top: 0;
+}
+
+.tabset.is-loading .tabs li:not(:first-child),
+.tabset:not(.is-loading) .tabs li:not(.is-active) {
+  background-color: black;
+  color: white;
+}
+
+.tabset.is-loading .tabs li:first-child::after,
+.tabs li.is-active::after {
+  background-color: white;
+  content: "";
+  display: block;
+  height: 3px; /* Chrome doesn't always paint the line accurately, so add a little extra */
+  position: absolute;
+  bottom: -1.5px;
+  left: 0;
+  right: 0;
+}
+
+.tabset > .content {
+  border: 1px solid gray;
+  padding: 1.25em;
+  margin-bottom: 1.25em;
+}
+
+.tabset.is-loading .tab-pane:not(:first-child),
+.tabset:not(.is-loading) .tab-pane:not(.is-active) {
+  display: none;
+}
+
+.tab-pane > :first-child {
+  margin-top: 0;
+}
+
+.tab-pane > :last-child > :last-child {
+  margin-bottom: 0;
+}

data/data/js/tabs.js

@@ -0,0 +1,51 @@
+/*! Asciidoctor Tabs behavior | Copyright (c) 2018-present Dan Allen | MIT License */
+;(function () {
+  'use strict'
+
+  var hash = window.location.hash
+  find('.tabset').forEach(function (tabset) {
+    var active
+    var tabs = tabset.querySelector('.tabs')
+    if (tabs) {
+      var first
+      find('li', tabs).forEach(function (tab, idx) {
+        var id = (tab.querySelector('a[id]') || tab).id
+        if (!id) return
+        var pane = getPane(id, tabset)
+        if (!idx) first = { tab: tab, pane: pane }
+        if (!active && hash === '#' + id && (active = true)) {
+          tab.classList.add('is-active')
+          if (pane) pane.classList.add('is-active')
+        } else if (!idx) {
+          tab.classList.remove('is-active')
+          if (pane) pane.classList.remove('is-active')
+        }
+        tab.addEventListener('click', activateTab.bind({ tabset: tabset, tab: tab, pane: pane }))
+      })
+      if (!active && first) {
+        first.tab.classList.add('is-active')
+        if (first.pane) first.pane.classList.add('is-active')
+      }
+    }
+    tabset.classList.remove('is-loading')
+  })
+
+  function activateTab (e) {
+    var tab = this.tab
+    var pane = this.pane
+    find('.tabs li, .tab-pane', this.tabset).forEach(function (it) {
+      it === tab || it === pane ? it.classList.add('is-active') : it.classList.remove('is-active')
+    })
+    e.preventDefault()
+  }
+
+  function find (selector, from) {
+    return Array.prototype.slice.call((from || document).querySelectorAll(selector))
+  }
+
+  function getPane (id, tabset) {
+    return find('.tab-pane', tabset).find(function (it) {
+      return it.getAttribute('aria-labelledby') === id
+    })
+  }
+})()

data/lib/asciidoctor/tabs/block.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  module Tabs
+    class Block < ::Asciidoctor::Extensions::BlockProcessor
+      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
+        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})
+        nodes << (create_html_fragment parent, %(<div id="#{id}" class="tabset is-loading">))
+        tabs = create_list parent, :ulist
+        tabs.add_role 'tabs'
+        panes = {}
+        source_tabs.items.each do |(title), details|
+          tab = create_list_item tabs
+          tabs << tab
+          tab_id = generate_id title.text, id
+          tab.text = %([[#{tab_id}]]#{title.instance_variable_get :@text})
+          if details.blocks?
+            blocks = details.blocks
+          elsif details.text?
+            blocks = [(create_paragraph parent, (details.instance_variable_get :@text), {})]
+          else
+            next
+          end
+          if (block0 = blocks[0]).context == :open && blocks.size == 1 && block0.blocks?
+            blocks = block0.blocks
+          end
+          (panes[tab_id] = blocks).each {|it| it.parent = parent }
+        end
+        nodes << tabs
+        nodes << (create_html_fragment parent, '<div class="content">')
+        panes.each do |tab_id, blocks|
+          nodes << (create_html_fragment parent, %(<div class="tab-pane" aria-labelledby="#{tab_id}">))
+          nodes.push(*blocks)
+          nodes << (create_html_fragment parent, '</div>')
+        end
+        nodes << (create_html_fragment parent, '</div>')
+        nodes << (create_html_fragment parent, '</div>')
+        nodes.each {|it| parent.blocks << it }
+        nil
+      end
+
+      private
+
+      def create_html_fragment parent, html
+        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})
+      end
+    end
+  end
+end

data/lib/asciidoctor/tabs/docinfo.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  module Tabs
+    module Docinfo
+      if RUBY_ENGINE == 'opal'
+        DATA_DIR = ::File.absolute_path '../data', %x(__dirname)
+        FILE_READ_MODE = 'r'
+      else
+        DATA_DIR = ::File.join (::File.absolute_path '../../..', __dir__), 'data'
+        FILE_READ_MODE = 'rb:utf-8:utf-8'
+      end
+
+      class Styles < ::Asciidoctor::Extensions::DocinfoProcessor
+        use_dsl
+        at_location :head
+
+        STYLESHEET_FILE = ::File.join DATA_DIR, 'css/tabs.css'
+
+        def process _doc
+          %(<style>\n#{(::File.read STYLESHEET_FILE, mode: FILE_READ_MODE).chomp}\n</style>)
+        end
+      end
+
+      class Behavior < ::Asciidoctor::Extensions::DocinfoProcessor
+        use_dsl
+        at_location :footer
+
+        JAVASCRIPT_FILE = ::File.join DATA_DIR, 'js/tabs.js'
+
+        def process _doc
+          %(<script>\n#{(::File.read JAVASCRIPT_FILE, mode: FILE_READ_MODE).chomp}\n</script>)
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/tabs/extensions.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'block'
+require_relative 'docinfo'
+
+module Asciidoctor
+  module Tabs
+    module Extensions
+      module_function
+
+      def group
+        proc do
+          block Block, :tabs
+          docinfo_processor Docinfo::Styles
+          docinfo_processor Docinfo::Behavior
+        end
+      end
+
+      def key
+        :tabs
+      end
+
+      def register
+        ::Asciidoctor::Extensions.register key, &group
+      end
+
+      def unregister
+        ::Asciidoctor::Extensions.groups.delete key
+      end
+    end
+  end
+end

data/lib/asciidoctor/tabs/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  module Tabs
+    VERSION = '1.0.0.alpha.1'
+  end
+end

data/lib/asciidoctor/tabs.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'tabs/extensions'
+
+Asciidoctor::Tabs::Extensions.register

data/lib/asciidoctor-tabs.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'asciidoctor/tabs'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-tabs
+version: !ruby/object:Gem::Version
+  version: 1.0.0.alpha.1
+platform: ruby
+authors:
+- Dan Allen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+description: An Asciidoctor extension that adds a tabs block to the AsciiDoc syntax.
+  The tabset is constructed from a dlist enclosed in an example block marked with
+  the tabs style.
+email: dan@opendevise.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.adoc
+- LICENSE
+- README.adoc
+- asciidoctor-tabs.gemspec
+- data/css/tabs.css
+- data/js/tabs.js
+- lib/asciidoctor-tabs.rb
+- lib/asciidoctor/tabs.rb
+- lib/asciidoctor/tabs/block.rb
+- lib/asciidoctor/tabs/docinfo.rb
+- lib/asciidoctor/tabs/extensions.rb
+- lib/asciidoctor/tabs/version.rb
+homepage: https://asciidoctor.org
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/asciidoctor/asciidoctor-tabs/issues
+  changelog_uri: https://github.com/asciidoctor/asciidoctor-tabs/blob/main/CHANGELOG.adoc
+  mailing_list_uri: https://chat.asciidoctor.org
+  source_code_uri: https://github.com/asciidoctor/asciidoctor-tabs
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: An Asciidoctor extension that adds a tabs block to the AsciiDoc syntax.
+test_files: []