Block processor extension / parseContent() does not perform substitutions

[d-gregorczyk]

I created a block processor extension that transform blocks of type "test" to regular sidebars, nothing spectacular (it does a bit more, but this is not of interest to the problem statement). Recently I found out that the block processor's parseContent() function does not perform substitutions, even if explicitly passed as attributes. Example code (Kotlin):

@Name("test")
@Contexts(Contexts.SIDEBAR)
@ContentModel(ContentModel.COMPOUND)
public class TestProcessor : BlockProcessor("test") {

    public override fun process(
        parent: StructuralNode,
        reader: Reader,
        attributes: MutableMap<String, Any>,
    ): Any {
        val block = createBlock(
            parent, "sidebar", mapOf(
                Options.ATTRIBUTES to attributes,
                ContentModel.KEY to ContentModel.COMPOUND
            )
        )

        parseContent(block, reader.readLines())
        return block
    }
}

The following content spits out the sidebar without any substution:

== Test

:attr: Foobar

[test#id, subs=normal]
****
Here is a sidebar with failed substitutions: {attr}
****

results in

while the converter without any block processors being applied substitutes attributes correctly.

Is that behavior on purpose, is it a bug or did I do something wrong?

Thanks for your help!

[robertpanzer]

It seems to work for me:

public class SubstitutionsTest {
public class SubstitutionsTest {
    @Name("test")
    @Contexts(Contexts.SIDEBAR)
    public static class SubsProcessor extends BlockProcessor {
        @Override
        public Object process(StructuralNode parent, Reader reader, Map<String, Object> attributes) {
            List<String> content = reader.readLines();
            return createBlock(parent, "sidebar", content,
                    Map.of("subs", "attributes"));
        }
    }

    @Test
    public void testSubstitutions() {
        try (var asciidoctor = Asciidoctor.Factory.create()) {
            asciidoctor.javaExtensionRegistry().block(SubsProcessor.class);
            String result = asciidoctor.convert("= Test\n:foo: bar\n\n[test]\n****\nThis is a {foo}\n****\n", Options.builder().build());
            System.out.println(result);
        }
    }
}

This prints:

<div class="sidebarblock">
<div class="content">
This is a bar
</div>
</div>

If I disable attribute substitutions by passing "-attributes" in the processor, the attribute is not substituted.

From your example I would guess that the attribute is not correctly defined.
There must not be an empty line between the title and the attributes.

[d-gregorczyk]

Hi Robert,

Please note that I am assigning the attribute below a level 2 heading, which works perfectly fine without the block processor, and with extra empty lines, but fails with the block processor being enabled:

public class SubstitutionsTest {
    @Name("test")
    @Contexts(Contexts.SIDEBAR)
    public static class SubsProcessor extends BlockProcessor {
        @Override
        public Object process(StructuralNode parent, Reader reader, Map<String, Object> attributes) {
            List<String> content = reader.readLines();
            return createBlock(parent, "sidebar", content,
                    Map.of("subs", "attributes"));
        }
    }

    @Test
    public void testBelowHeading2WithExtension() {
        try (var asciidoctor = Asciidoctor.Factory.create()) {
            asciidoctor.javaExtensionRegistry().block(SubsProcessor.class);
            String result = asciidoctor.convert("== Test\n:foo: replaced_content\n\n[test]\n****\nThis is a {foo}\n****\n", Options.builder().build());
            System.out.println(result);
            assertTrue(result.contains("replaced_content")) // fails
        }
    }

    @Test
    public void testBelowHeading2WithoutExtension() {
        try (var asciidoctor = Asciidoctor.Factory.create()) {
            // asciidoctor.javaExtensionRegistry().block(SubsProcessor.class);
            String result = asciidoctor.convert("== Test\n:foo: replaced_content\n\n[test]\n****\nThis is a {foo}\n****\n", Options.builder().build());
            System.out.println(result);
            assertTrue(result.contains("replaced_content")) // passes
        }
    }
}

Is testBelowHeading2WithoutExtension not supposed to be passing, i.e. assigning the attribute somewhere in the Asciidoc is not officially supported?