Asciidoctor: Remaining change admonishments

resources/asciidoctor/lib/change_admonishment/extension.rb

@@ -0,0 +1,78 @@
+require 'asciidoctor/extensions'
+
+include Asciidoctor
+
+##
+# Extensions for marking when something was added, when it *will* be added, or
+# when it was deprecated.
+#
+# Usage
+#
+#   added::[6.0.0-beta1]
+#   coming::[6.0.0-beta1]
+#   deprecated::[6.0.0-beta1]
+#   Foo added:[6.0.0-beta1]
+#   Foo coming:[6.0.0-beta1]
+#   Foo deprecated:[6.0.0-beta1]
+#
+class ChangeAdmonishment < Extensions::Group
+  def activate registry
+    [
+        [:added, 'added'],
+        [:coming, 'changed'],
+        [:deprecated, 'deleted'],
+    ].each { |(name, revisionflag)|
+      registry.block_macro ChangeAdmonishmentBlock.new(revisionflag), name
+      registry.inline_macro ChangeAdmonishmentInline.new(revisionflag), name
+    }
+  end
+
+  class ChangeAdmonishmentBlock < Extensions::BlockMacroProcessor
+    use_dsl
+    name_positional_attributes :version, :passtext
+
+    def initialize(revisionflag)
+      super
+      @revisionflag = revisionflag
+    end
+
+    def process parent, target, attrs
+      version = attrs[:version]
+      # We can *almost* go through the standard :admonition conversion but
+      # that won't render the revisionflag or the revision. So we have to
+      # go with this funny compound pass thing.
+      note = Block.new(parent, :pass, :content_model => :compound)
+      note << Block.new(note, :pass,
+          :source => "<note revisionflag=\"#{@revisionflag}\" revision=\"#{version}\">")
+      note << Block.new(note, :paragraph,
+          :source => attrs[:passtext],
+          :subs => Substitutors::NORMAL_SUBS)
+      note << Block.new(note, :pass, :source => "</note>")
+    end
+  end
+
+  class ChangeAdmonishmentInline < Extensions::InlineMacroProcessor
+    use_dsl
+    name_positional_attributes :version, :text
+    with_format :short
+
+    def initialize(revisionflag)
+      super
+      @revisionflag = revisionflag
+    end
+
+    def process parent, target, attrs
+      if attrs[:text]
+        <<~DOCBOOK
+          <phrase revisionflag="#{@revisionflag}" revision="#{attrs[:version]}">
+            #{attrs[:text]}
+          </phrase>
+        DOCBOOK
+      else
+        <<~DOCBOOK
+          <phrase revisionflag="#{@revisionflag}" revision="#{attrs[:version]}"/>
+        DOCBOOK
+      end
+    end
+  end
+end

resources/asciidoctor/lib/elastic_compat_preprocessor/extension.rb

@@ -7,15 +7,23 @@
 #
 # Turns
 #   added[6.0.0-beta1]
+#   changed[6.0.0-beta1]
+#   deprecated[6.0.0-beta1]
 # Into
 #   added::[6.0.0-beta1]
+#   changed::[6.0.0-beta1]
+#   deprecated::[6.0.0-beta1]
 # Because `::` is required by asciidoctor to invoke block macros but isn't
 # required by asciidoc.
 #
 # Turns
 #   words words added[6.0.0-beta1]
+#   words words changed[6.0.0-beta1]
+#   words words deprecated[6.0.0-beta1]
 # Into
 #   words words added:[6.0.0-beta1]
+#   words words changed:[6.0.0-beta1]
+#   words words deprecated:[6.0.0-beta1]
 # Because `:` is required by asciidoctor to invoke inline macros but isn't
 # required by asciidoc.
 #
@@ -140,12 +148,13 @@ def reader.process_line line
             @code_block_start = line
           end
         end
+        supported = 'added|coming|deprecated'
         # First convert the "block" version of these macros. We convert them
         # to block macros because they are at the start of the line....
-        line&.gsub!(/^(added)\[([^\]]*)\]/, '\1::[\2]')
+        line&.gsub!(/^(#{supported})\[([^\]]*)\]/, '\1::[\2]')
         # Then convert the "inline" version of these macros. We convert them
         # to inline macros because they are *not* at the start of the line....
-        line&.gsub!(/(added)\[([^\]]*)\]/, '\1:[\2]')
+        line&.gsub!(/(#{supported})\[([^\]]*)\]/, '\1:[\2]')
       end
     end
     reader

resources/asciidoctor/lib/extensions.rb

@@ -1,12 +1,12 @@
-require_relative 'added/extension'
+require_relative 'change_admonishment/extension'
 require_relative 'copy_images/extension'
 require_relative 'cramped_include/extension'
 require_relative 'edit_me/extension'
 require_relative 'elastic_compat_tree_processor/extension'
 require_relative 'elastic_compat_preprocessor/extension'
 require_relative 'elastic_include_tagged/extension'
 
-Extensions.register Added
+Extensions.register ChangeAdmonishment
 Extensions.register do
   # Enable storing the source locations so we can look at them. This is required
   # for EditMe to get a nice location.

resources/asciidoctor/spec/change_admonishment_spec.rb

@@ -0,0 +1,115 @@
+require 'change_admonishment/extension'
+
+RSpec.describe ChangeAdmonishment do
+  before(:each) do
+    Extensions.register ChangeAdmonishment
+  end
+
+  after(:each) do
+    Extensions.unregister_all
+  end
+
+  [
+      ['added', 'added'],
+      ['coming', 'changed'],
+      ['deprecated', 'deleted']
+  ].each { |(name, revisionflag)|
+    it "#{name}'s block version creates a note" do
+      actual = convert <<~ASCIIDOC
+        == Example
+        #{name}::[some_version]
+      ASCIIDOC
+      expected = <<~DOCBOOK
+        <chapter id="_example">
+        <title>Example</title>
+        <note revisionflag="#{revisionflag}" revision="some_version">
+        <simpara></simpara>
+        </note>
+        </chapter>
+      DOCBOOK
+      expect(actual).to eq(expected.strip)
+    end
+
+    it "#{name}'s block version supports asciidoc in the passtext" do
+    actual = convert <<~ASCIIDOC
+      == Example
+      #{name}::[some_version,See <<some-reference>>]
+      [[some-reference]]
+      === Some Reference
+    ASCIIDOC
+    expected = <<~DOCBOOK
+      <chapter id="_example">
+      <title>Example</title>
+      <note revisionflag="#{revisionflag}" revision="some_version">
+      <simpara>See <xref linkend="some-reference"/></simpara>
+      </note>
+      <section id="some-reference">
+      <title>Some Reference</title>
+
+      </section>
+      </chapter>
+    DOCBOOK
+    expect(actual).to eq(expected.strip)
+  end
+
+    it "#{name}'s block version is not invoked without the ::" do
+      actual = convert <<~ASCIIDOC
+        == Example
+        #{name}[some_version]
+      ASCIIDOC
+      expected = <<~DOCBOOK
+        <chapter id="_example">
+        <title>Example</title>
+        <simpara>#{name}[some_version]</simpara>
+        </chapter>
+      DOCBOOK
+      expect(actual).to eq(expected.strip)
+    end
+
+    it "#{name}'s inline version creates a phrase" do
+      actual = convert <<~ASCIIDOC
+        == Example
+        words #{name}:[some_version]
+      ASCIIDOC
+      expected = <<~DOCBOOK
+        <chapter id="_example">
+        <title>Example</title>
+        <simpara>words <phrase revisionflag="#{revisionflag}" revision="some_version"/>
+        </simpara>
+        </chapter>
+      DOCBOOK
+      expect(actual).to eq(expected.strip)
+    end
+
+    it "#{name}'s inline version creates a phrase with extra text if provided" do
+      actual = convert <<~ASCIIDOC
+        == Example
+        words #{name}:[some_version, more words]
+      ASCIIDOC
+      expected = <<~DOCBOOK
+        <chapter id="_example">
+        <title>Example</title>
+        <simpara>words <phrase revisionflag="#{revisionflag}" revision="some_version">
+          more words
+        </phrase>
+        </simpara>
+        </chapter>
+      DOCBOOK
+      expect(actual).to eq(expected.strip)
+    end
+
+    it "#{name}'s inline version is not invoked without the :" do
+      actual = convert <<~ASCIIDOC
+        == Example
+        words #{name}[some_version]
+      ASCIIDOC
+      expected = <<~DOCBOOK
+        <chapter id="_example">
+        <title>Example</title>
+        <simpara>words #{name}[some_version]</simpara>
+        </chapter>
+      DOCBOOK
+      expect(actual).to eq(expected.strip)
+    end
+  }
+end