asciidoctor-lists 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91209fcab613ba19c6917659a8b528c0390f35f421e8dca23a39863710ee7fbd
-  data.tar.gz: 55c77e4a5a78fe415605ea94ce08c29531f7ca9550797fba8c96ddc7b1cd3d35
+  metadata.gz: b9cdb3021862916257b05b2690050744ccbd65af0a872e94b67b1b2c13df5391
+  data.tar.gz: '059ab2fb1d8ce26edaa8768d98b9d8fea1e720e4212980a40127ab01bb0c8be3'
 SHA512:
-  metadata.gz: 1c66ea906439d1a2720fa32187d55e4f4e701c4e78e989b4f602787fbb1c68f71447960286bc90f9519018b7e39c267f3f50a37bee8b012e9edd6c3babf52d37
-  data.tar.gz: 7efe24289f4e643c5f6d424463b0ceeb4222d1e41cdd4508ad53b04cc72428feeefc77629ebd5ea93f851da892b7cec57c51348be8b1bd08918ee7bf5c1067d3
+  metadata.gz: e3e0da424fe5aa1c14338ee7bc92c3af8e088883494845381b9ef66e46447a962ad0397626aa50f6ee0f57b6410679ce76697dead5f9015d4c6337a9c463abf5
+  data.tar.gz: 15770d886027bd2a790839a07993d35d7705472221decee9213e59feee2cd43fd58f5443098ff3bf0009cad06b06686388cdaa7d9eb6be2dd5afed23475b0427

data/README.adoc

@@ -10,6 +10,8 @@ An https://asciidoctor.org/[asciidoctor] extension that adds a list of figures,
 
 *Pull Request 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[]

data/lib/asciidoctor-lists/extensions.rb

@@ -5,41 +5,39 @@ 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'
 
-    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']
       }
       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]
 
-         document.find_by(context: eval(element_name)).each do |element|
+         document.find_by(context: params[:element].to_sym).each do |element|
 
            if element.caption or element.title
              unless element.id
@@ -90,6 +88,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.6'
 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.6
 platform: ruby
 authors:
 - Alwin Schuster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor