asciidoctor-lists 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58e02dec63f52918b2ee0c8f5062d14eb451ef8c8847f07014e6d826c1c28a95
-  data.tar.gz: cefa380ff2daf11a8bffd28c6e5e957a3ec95e16bdb619d3f514c5f9ce0fd212
+  metadata.gz: c74f8ace24bdf759b089f51c96bdd3e8762d89d8e57ab8ebfa383ba953f61df3
+  data.tar.gz: acc23cc76d994d3d1c52e07c452e708aab39fa48518e998a3caec94a29fb4646
 SHA512:
-  metadata.gz: 5e96c24f4090ae29d3cfbaa9d95167bd8435a0510fcd3231b47cd822352a7fe603f933660eaa7b1aec12f8689f3217353b14d3e27ac566b40cc837e40ec9ca77
-  data.tar.gz: ad010ae3a5c0803d4431c702e1cb02d825aa76253d903c50540455fa450ecb20cbbc546192de71c14973efbbbbe0a2f9849633664564e831ae828bc06699e201
+  metadata.gz: 7669ee5f782c0f0ac76a872733a762568e1587dc88a57b96f4aa338244211d4cf5073a2702dbd8c8309e3744dac906a742b17b56b3af33796a836e8b34fad9f7
+  data.tar.gz: 59128a63e22e7af55146a9e19e94e0e112deb00c24b303bcd9953c4b2f6e1fc06c25a33851407b41fae6aceb4e19df79c0cd54590206a512da9ee8f28e43bd7c

data/README.adoc

@@ -1,41 +1,72 @@
-= 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
-WIP :)
+[source,asciidoc]
+----
+gem install asciidoctor-lists
+----
 
 == Sample
 === 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]
+image::img/sample.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)
+== Docker
+[source,bash]
+----
+# Build container
+docker build -t asciidoctor-lists .
+# Run Docker
+docker run -it --rm -v $(pwd):/work asciidoctor-lists
+# Build sample
+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.1.gem
+gem install asciidoctor-lists-x.x.x.gem
 ----

data/lib/asciidoctor-lists/extensions.rb

@@ -1,74 +1,65 @@
 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 < ::Extensions::BlockMacroProcessor
+  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
+             element.id = SecureRandom.uuid
+             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.1'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-lists
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Alwin Schuster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-03 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -53,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: An Asciidoctor extension that adds bibtex integration to AsciiDoc