asciidoctor-lists 0.0.3 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df21d7405e2bd61684ae02680874f92be4f0101a4cf270c27b64213326d43574
-  data.tar.gz: 7bf4131455afd55c97435dcb824556a9e58fd29fba57a4adaf1451409a47e732
+  metadata.gz: 7eeaecee95733de1e2291f1047db511b54c07079d55f910857226b87d0d5e522
+  data.tar.gz: b24e5796859234bb3da27c82b5081433c502970ab1d5146e9a51dbbf158338ee
 SHA512:
-  metadata.gz: 91ad039018f2c9efae5670dd242e92cd091885c4b00403320e588a79dab4ca5bd736becf8adbaf4ade4efb8deb49b5e5fd3add8eed3ad06cc81b54e9e01a4a16
-  data.tar.gz: e2756b56f60d202d7e4cc7e595a8b4e4800228f5015ddf10a6a2a39122581d19214b8c5af5420c0268f14793ee6d9583a9de6bea6c5a65847692e17b5dff39ab
+  metadata.gz: 2dd9fa38be20f3c80cc53ee06146ad906121a3ed15617fd979d7a5fa856f453b1a068ecbe4509312d45d40cd8981a3e6b5a4dfda9a9d74a59671ef32f19e07db
+  data.tar.gz: 4b4c5db93c285ddd289d1f6b5e48d0c369ad94c2ed1b47d17482da5e75891ade0dbec50a3733a5eb36420c4c59de2948dc446c5e90cbe3bf70234baaeb3ace4e

data/README.adoc

@@ -1,11 +1,12 @@
-= asciidoctor-lists (WIP)
-:toc: macro
-:toclevels: 1
+= asciidoctor-lists
 
+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]
 
-Adds a list of figures, list of tables (WIP) or list of anything you want!
+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! :)*
 
 == Install
 [source,asciidoc]
@@ -17,26 +18,33 @@ gem install asciidoctor-lists
 === Code
 [source,asciidoc]
 ----
-== Test the List of Figures Macro
+...
+
+.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
+|===
 
-.The wonderful linux logo
-image::https://upload.wikimedia.org/wikipedia/commons/3/35/Tux.svg[Linux Logo,100,100]
 
 .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]
 
-tof::[]
+=== List of tables
+element_list::[element=table]
 
 ----
 
 === Rendered
-image::https://user-images.githubusercontent.com/39517491/139903592-84e9e6cd-c1a8-45ec-acb7-52f37e366ddc.png[Sample,width=400]
-
-== What is planned next?
-* Link between image/table/element and list
-* Make generic (Also allow list of tables, or list of x)
+image::img/sample.png[Sample,width=400]
 
 == Docker
 [source,bash]
@@ -44,14 +52,21 @@ image::https://user-images.githubusercontent.com/39517491/139903592-84e9e6cd-c1a
 # Build container
 docker build -t asciidoctor-lists .
 # Run Docker
-docker run -it --rm -v $(pwd):/work asciidoctor-lists:latest
+docker run -it --rm -v $(pwd):/work asciidoctor-lists
 # Build sample
-asciidoctor-pdf -r asciidoctor-lists samples/list-of-figures.adoc
+asciidoctor-pdf -r asciidoctor-lists samples/list-sample.adoc
 ----
 
 == Dev setup
+=== Run
+[source,bash]
+----
+asciidoctor -r ./lib/asciidoctor-lists.rb samples/list-sample.adoc
+----
+
+=== Install Gem
 [source,bash]
 ----
 gem build asciidoctor-lists.gemspec
-gem install asciidoctor-lists-0.0.2.gem
+gem install asciidoctor-lists-x.x.x.gem
 ----

data/lib/asciidoctor-lists/extensions.rb

@@ -1,74 +1,67 @@
 require 'asciidoctor'
 require 'asciidoctor/extensions'
+require 'securerandom'
 
 module AsciidoctorLists
   module Asciidoctor
-  # An macro that adds a list of all figures
-  # It only uses images that have a caption!
-  #
-  # Usage
-  """
-  == Test the List of Figures Macro
 
-  .The wonderful linux logo
-  image::https://upload.wikimedia.org/wikipedia/commons/3/35/Tux.svg[Linux Logo,100,100]
-
-  .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
-
-  tof::[]
-  """
-  ListOfFiguresMacroPlaceholder = %(9d9711cf-0e95-4230-9973-78559fe928db)
+    MacroPlaceholder = Hash.new
 
   # Replaces tof::[] with ListOfFiguresMacroPlaceholder
   class ListOfFiguresMacro < ::Asciidoctor::Extensions::BlockMacroProcessor
     use_dsl
-    named :tof
+    named :element_list
+    name_positional_attributes 'element'
 
-    def process(parent, _target, _attrs)
-      create_paragraph parent, ListOfFiguresMacroPlaceholder, {}
+    def process(parent, _target, attrs)
+      uuid = SecureRandom.uuid
+      MacroPlaceholder[uuid] = {element: attrs['element']}
+      create_paragraph parent, uuid, {}
     end
   end
   # Searches for the figures and replaced ListOfFiguresMacroPlaceholder with the list of figures
   # Inspired by https://github.com/asciidoctor/asciidoctor-bibtex/blob/master/lib/asciidoctor-bibtex/extensions.rb#L162
   class ListOfFiguresTreeprocessor < ::Asciidoctor::Extensions::Treeprocessor
-     def process document
+     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]))
+       end
+       tof_blocks.each do |block|
          references_asciidoc = []
-         document.find_by(context: :image).each do |image|
+         element_name = ":" + MacroPlaceholder[block.lines[0]][:element]
+         document.find_by(context: eval(element_name)).each do |element|
 
-         if image.caption
-             references_asciidoc << %(#{image.caption}#{image.title} +)
-          end
-        end
-        tof_blocks = document.find_by do |b|
-          # for fast search (since most searches shall fail)
-          (b.content_model == :simple) && (b.lines.size == 1) \
-            && (b.lines[0] == ListOfFiguresMacroPlaceholder)
-        end
-        tof_blocks.each do |block|
-          block_index = block.parent.blocks.index do |b|
-            b == block
-          end
-          reference_blocks = parse_asciidoc block.parent, references_asciidoc
-          reference_blocks.reverse.each do |b|
-            block.parent.blocks.insert block_index, b
-          end
-          block.parent.blocks.delete_at block_index + reference_blocks.size
-        end
-      end
+           if element.caption
+             unless element.id
+               element.id = SecureRandom.uuid
+             end
+             references_asciidoc << %(xref:#{element.id}[#{element.caption}]#{element.title} +)
+           end
+         end
+
+         block_index = block.parent.blocks.index do |b|
+           b == block
+         end
+         reference_blocks = parse_asciidoc block.parent, references_asciidoc
+         reference_blocks.reverse.each do |b|
+           block.parent.blocks.insert block_index, b
+         end
+         block.parent.blocks.delete_at block_index + reference_blocks.size
+       end
+     end
       # This is an adapted version of Asciidoctor::Extension::parse_content,
       # where resultant blocks are returned as a list instead of attached to
       # the parent.
       def parse_asciidoc(parent, content, attributes = {})
-      result = []
-      reader = ::Asciidoctor::Reader.new content
-      while reader.has_more_lines?
-        block = ::Asciidoctor::Parser.next_block reader, parent, attributes
-        result << block if block
-      end
-      result
+        result = []
+        reader = ::Asciidoctor::Reader.new content
+        while reader.has_more_lines?
+          block = ::Asciidoctor::Parser.next_block reader, parent, attributes
+          result << block if block
+        end
+        result
       end
     end
   end

data/lib/asciidoctor-lists/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-lists
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.3
 platform: ruby
 authors:
 - Alwin Schuster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-04 00:00:00.000000000 Z
+date: 2022-01-20 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: []
@@ -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: []