asciidoctor-lists 1.0.2 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 938bd9392b0c912ac112ced82ebef41f9bbf0772215f7d1a5f5bc1b5fdfa0a9a
-  data.tar.gz: 45b6506f0adfc38b3ae52077e26a1ee4f8d8bc3bcded0c8a99e1b98ac5696a77
+  metadata.gz: b9cdb3021862916257b05b2690050744ccbd65af0a872e94b67b1b2c13df5391
+  data.tar.gz: '059ab2fb1d8ce26edaa8768d98b9d8fea1e720e4212980a40127ab01bb0c8be3'
 SHA512:
-  metadata.gz: 82b2c2dd1b85bd0d4b163110033c801f023795a2b42133639f5449541916fba75b66ab06ddef1c1e13de40c3b122d471fe7a1d2a9fe9c0b7fa893036fb965d87
-  data.tar.gz: cd5ed1b976130783ba8ff6badc212eadc123d6a0906ea4575020e55fdebee56189a78015838d2ce001bbe63041997843aeb0bcff0b53027fe278e738b10704cf
+  metadata.gz: e3e0da424fe5aa1c14338ee7bc92c3af8e088883494845381b9ef66e46447a962ad0397626aa50f6ee0f57b6410679ce76697dead5f9015d4c6337a9c463abf5
+  data.tar.gz: 15770d886027bd2a790839a07993d35d7705472221decee9213e59feee2cd43fd58f5443098ff3bf0009cad06b06686388cdaa7d9eb6be2dd5afed23475b0427

data/README.adoc

@@ -3,11 +3,15 @@
 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! :)*
 
+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,32 @@ 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 which should be listed
+
+Sample: link:samples/list-sample.adoc[]
+
+=== enhanced_rendering (experimental)
+Allows to render links in the caption
+
+Sample: link:samples/enhanced-rendering.adoc[]
+
 == Docker
 [source,bash]
 ----
@@ -69,4 +73,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,39 +5,58 @@ 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'
 
-    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 = []
-         element_name = ":" + MacroPlaceholder[block.lines[0]][:element]
-         document.find_by(context: eval(element_name)).each do |element|
 
-           if element.caption
+         params = ListMacroAttributes[block.lines[0]]
+         enhanced_rendering = params[:enhanced_rendering]
+
+         document.find_by(context: params[:element].to_sym).each do |element|
+
+           if element.caption or element.title
              unless element.id
                element.id = SecureRandom.uuid
              end
-             references_asciidoc << %(xref:#{element.id}[#{element.caption}]#{element.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
+             end
            end
          end
 
@@ -69,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.2'
+  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.2
+  version: 1.0.6
 platform: ruby
 authors:
 - Alwin Schuster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -24,7 +24,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: Adds lists
+description: An asciidoctor extension that adds a list of figures, a list of tables,
+  or a list of anything you want!
 email: 
 executables: []
 extensions: []
@@ -36,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: []
@@ -56,5 +57,6 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: An Asciidoctor extension that adds bibtex integration to AsciiDoc
+summary: An asciidoctor extension that adds a list of figures, a list of tables, or
+  a list of anything you want!
 test_files: []