doc/asciidoctor-macros/commaize-block/extension.rb

   1 # SPDX-License-Identifier: MIT
   2 require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
   3
   4 include Asciidoctor
   5
   6 # An extension that converts a list of lines to an inline Oxford comma-separated list.
   7 #
   8 # Usage
   9 #
  10 #   [commaize]
  11 #   --
  12 #   item1
  13 #   item2
  14 #   item3
  15 #   --
  16 #
  17 class CommaizeBlock < Extensions::BlockProcessor
  18   include WsUtils
  19   use_dsl
  20
  21   named :commaize
  22   on_contexts :paragraph, :open
  23   # XXX What's the difference between text, raw, simple, verbatim, etc?
  24   parse_content_as :simple
  25
  26   def process(parent, reader, attrs)
  27     lines = reader.lines
  28     sort = attrs.fetch('sort', 'true') == 'true'
  29
  30     lines = lines.reject(&:empty?)
  31     lines = lines.map(&:strip)
  32     lines = lines.sort_by(&:downcase) if sort
  33
  34     if lines.length < 2
  35       create_paragraph parent, lines, attrs
  36     elsif lines.length == 2
  37       create_paragraph parent, lines.join(" and "), attrs
  38     else
  39       commaized = lines[0..-2].join(", ")
  40       commaized << ", and " + lines[-1]
  41       create_paragraph parent, commaized, attrs
  42     end
  43   end
  44 end