asciidoctor-lists 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58e02dec63f52918b2ee0c8f5062d14eb451ef8c8847f07014e6d826c1c28a95
+  data.tar.gz: cefa380ff2daf11a8bffd28c6e5e957a3ec95e16bdb619d3f514c5f9ce0fd212
+SHA512:
+  metadata.gz: 5e96c24f4090ae29d3cfbaa9d95167bd8435a0510fcd3231b47cd822352a7fe603f933660eaa7b1aec12f8689f3217353b14d3e27ac566b40cc837e40ec9ca77
+  data.tar.gz: ad010ae3a5c0803d4431c702e1cb02d825aa76253d903c50540455fa450ecb20cbbc546192de71c14973efbbbbe0a2f9849633664564e831ae828bc06699e201

data/README.adoc

@@ -0,0 +1,41 @@
+= asciidoctor-lists (WIP)
+:toc: macro
+:toclevels: 1
+
+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!
+
+== Install
+WIP :)
+
+== Sample
+=== Code
+[source,asciidoc]
+----
+== 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::[]
+
+----
+
+=== 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)
+
+== Dev setup
+[source,bash]
+----
+gem build asciidoctor-lists.gemspec
+gem install asciidoctor-lists-0.0.1.gem
+----

data/lib/asciidoctor-lists/extensions.rb

@@ -0,0 +1,81 @@
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+
+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)
+
+  # Replaces tof::[] with ListOfFiguresMacroPlaceholder
+  class ListOfFiguresMacro < ::Extensions::BlockMacroProcessor
+    use_dsl
+    named :tof
+
+    def process(parent, target, attrs)
+      create_paragraph parent, ListOfFiguresMacroPlaceholder, {}
+    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
+         references_asciidoc = []
+         document.find_by(context: :image).each do |image|
+
+         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
+      # 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
+      end
+    end
+  end
+end
+
+# Register the extensions to asciidoctor
+Asciidoctor::Extensions.register do
+  block_macro AsciidoctorLists::Asciidoctor::ListOfFiguresMacro
+  tree_processor AsciidoctorLists::Asciidoctor::ListOfFiguresTreeprocessor
+end

data/lib/asciidoctor-lists/version.rb

@@ -0,0 +1,3 @@
+module AsciidoctorLists
+  VERSION = '0.0.1'
+end

data/lib/asciidoctor-lists.rb

@@ -0,0 +1,2 @@
+require_relative 'asciidoctor-lists/extensions'
+require_relative 'asciidoctor-lists/version'

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-lists
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alwin Schuster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Adds lists
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.adoc
+- lib/asciidoctor-lists.rb
+- lib/asciidoctor-lists/extensions.rb
+- lib/asciidoctor-lists/version.rb
+homepage: https://github.com/Alwinator/asciidoctor-lists
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.5
+signing_key: 
+specification_version: 4
+summary: An Asciidoctor extension that adds bibtex integration to AsciiDoc
+test_files: []