asciidoctor-lists 1.0.5 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91209fcab613ba19c6917659a8b528c0390f35f421e8dca23a39863710ee7fbd
-  data.tar.gz: 55c77e4a5a78fe415605ea94ce08c29531f7ca9550797fba8c96ddc7b1cd3d35
+  metadata.gz: 4e4c385d098f83a5dc7c73e70afe4e09c1a414b5b8e6ceeb1c12aef78f47b372
+  data.tar.gz: 8536f12d37553f0c813719d69871c5073378b0aff7fdb973a26c72bd7fde6682
 SHA512:
-  metadata.gz: 1c66ea906439d1a2720fa32187d55e4f4e701c4e78e989b4f602787fbb1c68f71447960286bc90f9519018b7e39c267f3f50a37bee8b012e9edd6c3babf52d37
-  data.tar.gz: 7efe24289f4e643c5f6d424463b0ceeb4222d1e41cdd4508ad53b04cc72428feeefc77629ebd5ea93f851da892b7cec57c51348be8b1bd08918ee7bf5c1067d3
+  metadata.gz: 5c1d33f380081b1e4a7e28a64c45298df459e7ec8298a72baa9315beb3bb4088deda57bf76d31414b0e0432eade7ed56620417b11a29b35547da9446208a5931
+  data.tar.gz: 327515c647fb79c583011fc2271012a43ae502e5e9bd5919f2c89a647e1024041074ad20973512a74f9b74a602bef8fe2e4a2acff75f9d48880cabf109ae67fe

data/README.adoc

@@ -8,7 +8,9 @@ image:https://img.shields.io/github/stars/Alwinator/asciidoctor-lists[Stars, lin
 
 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]
@@ -23,13 +25,13 @@ gem install asciidoctor-lists
 ...
 
 === List of figures
-element_list::[element=image]
+list-of::image[]
 
 === List of tables
-element_list::[element=table]
+list-of::table[]
 
 === List of code snippets
-element_list::[element=listing]
+list-of::listing[]
 ----
 
 See link:samples/list-sample.adoc[]
@@ -39,15 +41,20 @@ image::img/sample.png[Sample,width=400]
 
 == Parameters
 === element
-Specifies the element which should be listed
+Specifies the element to be listed
 
 Sample: link:samples/list-sample.adoc[]
 
 === enhanced_rendering (experimental)
-Allows to render links in the caption
+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]
 ----
@@ -72,3 +79,6 @@ asciidoctor -r ./lib/asciidoctor-lists.rb samples/list-sample.adoc
 gem build asciidoctor-lists.gemspec
 gem install asciidoctor-lists-x.x.x.gem
 ----
+
+== Docker Image
+- Support in official asciidoctor Docker image is waiting for approval (See https://github.com/asciidoctor/docker-asciidoctor/pull/262)

data/lib/asciidoctor-lists/extensions.rb

@@ -5,61 +5,67 @@ require 'securerandom'
 module AsciidoctorLists
   module Asciidoctor
 
-    MacroPlaceholder = Hash.new
+    ListMacroAttributes = Hash.new
 
-  # Replaces element_list::[element=...] 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'],
-        enhanced_rendering: attrs['enhanced_rendering']
+      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 = []
 
-         params = MacroPlaceholder[block.lines[0]]
-         element_name = ":" + params[:element]
+         params = ListMacroAttributes[block.lines[0]]
          enhanced_rendering = params[:enhanced_rendering]
+         hide_empty_section = params[:hide_empty_section]
 
-         document.find_by(context: eval(element_name)).each do |element|
+         elements = document.find_by(traverse_documents: true, 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 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)}] +)
+               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
-               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
+         elsif hide_empty_section
+           block.parent.parent.blocks.delete block.parent
          end
 
          block_index = block.parent.blocks.index do |b|
@@ -90,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.5'
+  VERSION = '1.0.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-lists
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.8
 platform: ruby
 authors:
 - Alwin Schuster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2022-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor