resolves #1652 Map AbstractBlock#getContentModel and #setContentModel (…

…#1680)

resolves #1652

packages/core/spec/share/asciidoctor-spec.cjs

@@ -1024,6 +1024,22 @@ paragraph 3
         expect(paragraph.getAttribute('foo')).to.equal('bar')
       })
 
+      it('should create a new paragraph block with verbatim content model', function () {
+        const doc = asciidoctor.load('= Title')
+        const paragraph = asciidoctor.Block.create(doc, 'paragraph', { source: '    _This_ is a <test>' })
+        paragraph.setContentModel('verbatim')
+        expect(paragraph.getContentModel()).to.equal('verbatim')
+        expect(paragraph.getContent()).to.equal('    _This_ is a <test>')
+      })
+
+      it('should create a new literal block with empty content model', function () {
+        const doc = asciidoctor.load('= Title')
+        const paragraph = asciidoctor.Block.create(doc, 'literal', { source: '_This_ is a <test>' })
+        paragraph.setContentModel('empty')
+        expect(paragraph.getContentModel()).to.equal('empty')
+        expect(paragraph.getContent()).to.be.undefined()
+      })
+
       it('should assign a caption on a Block', function () {
         const doc = asciidoctor.load('= Title')
         const image = asciidoctor.Block.create(doc, 'image', {

packages/core/src/asciidoctor-core-api.js

@@ -445,6 +445,30 @@ Asciidoctor.prototype.loadFile = function (filename, options) {
  */
 const AbstractBlock = Opal.Asciidoctor.AbstractBlock
 
+/**
+ *  Describes the type of content this block accepts and how it should be converted.
+ * @returns {string} - the type of content this block accepts.
+ * @memberof AbstractBlock
+ */
+AbstractBlock.prototype.getContentModel = function () {
+  const contentModel = this.content_model
+  return contentModel === Opal.nil ? undefined : contentModel
+}
+
+/**
+ *  Set the type of content this block accepts. Acceptable values are:
+ *  - compound - this block contains other blocks
+ *  - simple - this block holds a paragraph of prose that receives normal substitutions
+ *  - verbatim - this block holds verbatim text (displayed "as is") that receives verbatim substitutions
+ *  - raw - this block holds unprocessed content passed directly to the output with no substitutions applied
+ *  - empty - this block has no content
+ * @param {string} contentModel - type of content, one of: compound, simple, verbatim, raw or empty.
+ * @memberof AbstractBlock
+ */
+AbstractBlock.prototype.setContentModel = function (contentModel) {
+  this.content_model = contentModel
+}
+
 /**
  * Append a block to this block's list of child blocks.
  * @param {AbstractBlock} block - the block to append
@@ -457,7 +481,7 @@ AbstractBlock.prototype.append = function (block) {
 }
 
 /**
- * Get the String title of this Block with title substitions applied
+ * Get the String title of this Block with title substitutions applied
  *
  * The following substitutions are applied to block and section titles:
  *
@@ -664,7 +688,8 @@ AbstractBlock.prototype.getBlocks = function () {
  * @memberof AbstractBlock
  */
 AbstractBlock.prototype.getContent = function () {
-  return this.$content()
+  const content = this.$content()
+  return content === Opal.nil ? undefined : content
 }
 
 /**

packages/core/types/index.d.ts

@@ -1983,15 +1983,35 @@ export class Document extends AbstractBlock {
   getExtensions(): Registry;
 }
 
-/**
- */
-export class AbstractBlock extends AbstractNode {
+type ContentModel = 'compound' | 'simple' | 'verbatim' | 'raw' | 'empty'
+
   /**
-   * Append a block to this block's list of child blocks.
-   * @param block - the block to append
-   * @returns the parent block to which this block was appended.
    */
-  append(block: AbstractBlock): AbstractBlock;
+ export class AbstractBlock extends AbstractNode {
+
+    /**
+     * Describes the type of content this block accepts and how it should be converted.
+     * @returns the type of content this block accepts.
+     */
+    getContentModel(): ContentModel
+
+    /**
+     *  Set the type of content this block accepts. Acceptable values are:
+     *  - compound - this block contains other blocks
+     *  - simple - this block holds a paragraph of prose that receives normal substitutions
+     *  - verbatim - this block holds verbatim text (displayed "as is") that receives verbatim substitutions
+     *  - raw - this block holds unprocessed content passed directly to the output with no substitutions applied
+     *  - empty - this block has no content
+     * @param contentModel - the type of content
+     */
+    setContentModel(contentModel: ContentModel): void;
+
+    /**
+     * Append a block to this block's list of child blocks.
+     * @param block - the block to append
+     * @returns the parent block to which this block was appended.
+     */
+    append(block: AbstractBlock): AbstractBlock;
 
   /**
    * Get the String title of this Block with title substitions applied
@@ -2118,7 +2138,7 @@ export class AbstractBlock extends AbstractNode {
    * Get the converted result of the child blocks by converting the children appropriate to content model that this block supports.
    * @returns the converted result of the child blocks
    */
-  getContent(): string;
+  getContent(): string|undefined;
 
   /**
    * Get the converted content for this block.

packages/core/types/tests.ts

@@ -120,6 +120,16 @@ assert(attributes.count === 3);
 assert(attributes.awesome);
 assert(attributes.status === 'passive');
 
+const literalBlockWithEmptyContentModel = processor.Block.create(doc, 'literal', { source: '_This_ is a <test>' });
+literalBlockWithEmptyContentModel.setContentModel('empty')
+assert(literalBlockWithEmptyContentModel.getContentModel() === 'empty');
+assert(literalBlockWithEmptyContentModel.getContent() === undefined);
+
+const paragraphBlockWithVerbatimContentModel = processor.Block.create(doc, 'paragraph', { source: '_This_ is a <test>' });
+paragraphBlockWithVerbatimContentModel.setContentModel('verbatim')
+assert(paragraphBlockWithVerbatimContentModel.getContentModel() === 'verbatim');
+assert(paragraphBlockWithVerbatimContentModel.getContent() === '_This_ is a <test>');
+
 // Section
 const section = processor.Section.create();
 section.setId('sect1');