asciidoctor-lists 1.0.3 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7eeaecee95733de1e2291f1047db511b54c07079d55f910857226b87d0d5e522
-  data.tar.gz: b24e5796859234bb3da27c82b5081433c502970ab1d5146e9a51dbbf158338ee
+  metadata.gz: ac525c818bc5254204312158fee82493102b5d61477c3d17e8f6d4a1b6049ebd
+  data.tar.gz: cc8dd13be8fbc15c04627733a0784c2963ddbad3689a2d180af25a15c2b1ef45
 SHA512:
-  metadata.gz: 2dd9fa38be20f3c80cc53ee06146ad906121a3ed15617fd979d7a5fa856f453b1a068ecbe4509312d45d40cd8981a3e6b5a4dfda9a9d74a59671ef32f19e07db
-  data.tar.gz: 4b4c5db93c285ddd289d1f6b5e48d0c369ad94c2ed1b47d17482da5e75891ade0dbec50a3733a5eb36420c4c59de2948dc446c5e90cbe3bf70234baaeb3ace4e
+  metadata.gz: c6c3a5fd8b0ff322ad297070ed7796d758e4ad0c4d5efb1e285272f12b7b0b9323e90417852f3196aa700cdedb4ae9b5213192598b6f456c59bc55cc6ce4056c
+  data.tar.gz: 8677b62b1edbf1e6024f91422e6ca8670eff647258ac1ced4d8db03f3af9749685f5c1179da3cfbe7dcdf36598b4233ac1ee7b7a7ccfcce2ab1c6d0c39fb2f37

data/README.adoc

@@ -3,10 +3,14 @@
 image:https://github.com/Alwinator/asciidoctor-lists/actions/workflows/test.yml/badge.svg[Test, link=https://github.com/Alwinator/asciidoctor-lists/actions/workflows/test.yml]
 image:https://github.com/Alwinator/asciidoctor-lists/actions/workflows/publish_gem.yml/badge.svg[Build, link=https://github.com/Alwinator/asciidoctor-lists/actions/workflows/publish_gem.yml]
 image:https://img.shields.io/gem/v/asciidoctor-lists.svg[Latest Release, link=https://rubygems.org/gems/asciidoctor-lists]
+image:https://img.shields.io/github/stars/Alwinator/asciidoctor-lists[Stars, link=https://github.com/Alwinator/asciidoctor-lists]
+
 
 An https://asciidoctor.org/[asciidoctor] extension that adds a list of figures, a list of tables, or a list of anything you want!
 
-*Pull Request are always welcome! :)*
+*Pull Requests are always welcome! :)*
+
+IMPORTANT: With version 1.0.6 the syntax was changed from `element_list::[element=image]` to `list-of::image[]` to make it more intuitive.
 
 == Install
 [source,asciidoc]
@@ -20,32 +24,37 @@ gem install asciidoctor-lists
 ----
 ...
 
-.And this is the second one
-|===
-|Column 1, Header Row |Column 2, Header Row
-
-|Cell in column 1, row 1
-|Cell in column 2, row 1
-
-|Cell in column 1, row 2
-|Cell in column 2, row 2
-|===
-
-
-.Another wikipedia SVG image
-image::https://upload.wikimedia.org/wikipedia/commons/thumb/4/4f/SVG_Logo.svg/400px-SVG_Logo.svg.png[SVG,100,100]
-
 === List of figures
-element_list::[element=image]
+list-of::image[]
 
 === List of tables
-element_list::[element=table]
+list-of::table[]
 
+=== List of code snippets
+list-of::listing[]
 ----
 
+See link:samples/list-sample.adoc[]
+
 === Rendered
 image::img/sample.png[Sample,width=400]
 
+== Parameters
+=== element
+Specifies the element to be listed
+
+Sample: link:samples/list-sample.adoc[]
+
+=== enhanced_rendering (experimental)
+Allows rendering links in the caption
+
+Sample: link:samples/enhanced-rendering.adoc[]
+
+=== hide_empty_section
+Removes the section when no elements are found
+
+Sample: link:samples/hide-if-empty-list-sample.adoc
+
 == Docker
 [source,bash]
 ----
@@ -69,4 +78,4 @@ asciidoctor -r ./lib/asciidoctor-lists.rb samples/list-sample.adoc
 ----
 gem build asciidoctor-lists.gemspec
 gem install asciidoctor-lists-x.x.x.gem
-----
+----

data/lib/asciidoctor-lists/extensions.rb

@@ -5,40 +5,67 @@ require 'securerandom'
 module AsciidoctorLists
   module Asciidoctor
 
-    MacroPlaceholder = Hash.new
+    ListMacroAttributes = Hash.new
 
-  # Replaces tof::[] with ListOfFiguresMacroPlaceholder
-  class ListOfFiguresMacro < ::Asciidoctor::Extensions::BlockMacroProcessor
+  # Replaces list-of::element[] with UUID and saves attributes in ListMacroPlaceholder
+  class ListMacro < ::Asciidoctor::Extensions::BlockMacroProcessor
     use_dsl
-    named :element_list
-    name_positional_attributes 'element'
+    named :"list-of"
+    name_positional_attributes 'enhanced_rendering'
+    name_positional_attributes 'hide_empty_section'
 
-    def process(parent, _target, attrs)
+    def process(parent, target, attrs)
       uuid = SecureRandom.uuid
-      MacroPlaceholder[uuid] = {element: attrs['element']}
+      ListMacroAttributes[uuid] = {
+        element: target,
+        enhanced_rendering: attrs['enhanced_rendering'],
+        hide_empty_section: attrs['hide_empty_section']
+      }
       create_paragraph parent, uuid, {}
     end
   end
-  # Searches for the figures and replaced ListOfFiguresMacroPlaceholder with the list of figures
+  # Searches for the elements and replaced the UUIDs with the lists
   # Inspired by https://github.com/asciidoctor/asciidoctor-bibtex/blob/master/lib/asciidoctor-bibtex/extensions.rb#L162
-  class ListOfFiguresTreeprocessor < ::Asciidoctor::Extensions::Treeprocessor
+  class ListTreeprocessor < ::Asciidoctor::Extensions::Treeprocessor
      def process(document)
        tof_blocks = document.find_by do |b|
          # for fast search (since most searches shall fail)
          (b.content_model == :simple) && (b.lines.size == 1) \
-            && (MacroPlaceholder.keys.include?(b.lines[0]))
+            && (ListMacroAttributes.keys.include?(b.lines[0]))
        end
        tof_blocks.each do |block|
          references_asciidoc = []
-         element_name = ":" + MacroPlaceholder[block.lines[0]][:element]
-         document.find_by(context: eval(element_name)).each do |element|
 
-           if element.caption
-             unless element.id
-               element.id = SecureRandom.uuid
+         params = ListMacroAttributes[block.lines[0]]
+         enhanced_rendering = params[:enhanced_rendering]
+         hide_empty_section = params[:hide_empty_section]
+
+         elements = document.find_by(context: params[:element].to_sym)
+         if elements.length > 0
+           elements.each do |element|
+
+             if element.caption or element.title
+               unless element.id
+                 element.id = SecureRandom.uuid
+               end
+
+               if enhanced_rendering
+                   if element.caption
+                     references_asciidoc << %(xref:#{element.id}[#{element.caption}]#{element.instance_variable_get(:@title)} +)
+                   else element.caption
+                     references_asciidoc << %(xref:#{element.id}[#{element.instance_variable_get(:@title)}] +)
+                   end
+                 else
+                   if element.caption
+                    references_asciidoc << %(xref:#{element.id}[#{element.caption}]#{element.title} +)
+                   else element.caption
+                    references_asciidoc << %(xref:#{element.id}[#{element.title}] +)
+                 end
+               end
              end
-             references_asciidoc << %(xref:#{element.id}[#{element.caption}]#{element.title} +)
            end
+         elsif hide_empty_section
+           block.parent.parent.blocks.delete block.parent
          end
 
          block_index = block.parent.blocks.index do |b|
@@ -69,6 +96,6 @@ end
 
 # Register the extensions to asciidoctor
 Asciidoctor::Extensions.register do
-  block_macro AsciidoctorLists::Asciidoctor::ListOfFiguresMacro
-  tree_processor AsciidoctorLists::Asciidoctor::ListOfFiguresTreeprocessor
+  block_macro AsciidoctorLists::Asciidoctor::ListMacro
+  tree_processor AsciidoctorLists::Asciidoctor::ListTreeprocessor
 end

data/lib/asciidoctor-lists/version.rb

@@ -1,3 +1,3 @@
 module AsciidoctorLists
-  VERSION = '1.0.3'
+  VERSION = '1.0.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-lists
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.7
 platform: ruby
 authors:
 - Alwin Schuster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -37,7 +37,7 @@ files:
 - lib/asciidoctor-lists/version.rb
 homepage: https://github.com/Alwinator/asciidoctor-lists
 licenses:
-- MIT
+- MPL-2
 metadata: {}
 post_install_message: 
 rdoc_options: []