greenmat 3.5.1.1 → 3.5.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ebea41bf33e060dc7d4a5c28fbac9e49759062ac85dcbea55b14b1485cd18f1
-  data.tar.gz: 18cf03b8c7b166736b13326d3e601384b3776d6a65384f46dbf7d7d9545a5528
+  metadata.gz: daa8ed611ae782a62d258d93782f3d1f16c22dc2652b585cccab4de9dfe42e89
+  data.tar.gz: afa9532f8877f4d9ba397e7cdee11977917121256726cf28770386964a11078d
 SHA512:
-  metadata.gz: 7e2eb93fbef73b7bb5853db8e107910bf3e7b8e89a649496040cdf665a9b97f54fd0031e0f042c1f6622764e51a85d87bada46d60b0ccbcb352e7743134daab3
-  data.tar.gz: 6da0421b78cf1b71fd92c080b62aeec8dc74726b999d5d4afb9dc10e465e15b0db28fef67d1d0343940bea56717ec94e944d47a6dfabbe8269dfd0d100fbd746
+  metadata.gz: a0be5ca05b7c5fda9ef29e57737667724ca6d3cf700e849fd194e77d4813aeba3e86de1cc20a3aabe1b8bde2c4fb3e67cbcd2eafa0557b5ec3011b342bf59c4a
+  data.tar.gz: 97e0df05af1a790e5ce7af95812e824ce71bd1b3ff8981cb988a18ec570bedd54d493e0884818d1e2e76be7e3d7df8df3981c0d6b9e4ecba3cb2ea417d752171

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+## v3.5.1.2
+
+* Support custom block notation.
+  * It starts with `:::` and ends with `:::`.
+  * Output a `<div data-type="customblock" data-metadata="">` element.
+  * Passes the string following `:::` to the `data-metadata` attribute.
+
 ## v3.5.1.1
 
 * Unsupport details and summary tags.

data/Rakefile

@@ -4,6 +4,7 @@ require 'rake/extensiontask'
 require 'digest/md5'
 
 task :default => [:test, :spec]
+task :spec => [:compile]
 
 # Gem Spec
 gem_spec = Gem::Specification.load('greenmat.gemspec')

data/ext/greenmat/gm_markdown.c

@@ -48,6 +48,9 @@ static void rb_greenmat_md_flags(VALUE hash, unsigned int *enabled_extensions_p)
 	if (rb_hash_lookup(hash, CSTR2SYM("fenced_code_blocks")) == Qtrue)
 		extensions |= MKDEXT_FENCED_CODE;
 
+	if (rb_hash_lookup(hash, CSTR2SYM("fenced_custom_blocks")) == Qtrue)
+		extensions |= MKDEXT_FENCED_CUSTOM;
+
 	if (rb_hash_lookup(hash, CSTR2SYM("disable_indented_code_blocks")) == Qtrue)
 		extensions |= MKDEXT_DISABLE_INDENTED_CODE;
 

data/ext/greenmat/gm_render.c

@@ -54,6 +54,12 @@ rndr_blockcode(struct buf *ob, const struct buf *text, const struct buf *lang, v
 	BLOCK_CALLBACK("block_code", 2, buf2str(text), buf2str(lang));
 }
 
+static void
+rndr_blockcustom(struct buf *ob, const struct buf *text, const struct buf *type, void *opaque)
+{
+	BLOCK_CALLBACK("block_custom", 2, buf2str(text), buf2str(type));
+}
+
 static void
 rndr_blockquote(struct buf *ob, const struct buf *text, void *opaque)
 {
@@ -293,6 +299,7 @@ rndr_link_attributes(struct buf *ob, const struct buf *url, void *opaque)
 
 static struct sd_callbacks rb_greenmat_callbacks = {
 	rndr_blockcode,
+	rndr_blockcustom,
 	rndr_blockquote,
 	rndr_raw_block,
 	rndr_header,
@@ -331,6 +338,7 @@ static struct sd_callbacks rb_greenmat_callbacks = {
 
 static const char *rb_greenmat_method_names[] = {
 	"block_code",
+	"block_custom",
 	"block_quote",
 	"block_html",
 	"header",

data/ext/greenmat/html.c

@@ -120,6 +120,52 @@ rndr_autolink(struct buf *ob, const struct buf *link, enum mkd_autolink type, vo
 	return 1;
 }
 
+static void
+rndr_blockcustom(struct buf *ob, const struct buf *text, const struct buf *type, void *opaque)
+{
+	struct html_renderopt *options = opaque;
+
+	if (ob->size) bufputc(ob, '\n');
+
+	if (type && type->size) {
+		size_t i, cls;
+		if (options->flags & HTML_PRETTIFY) {
+			BUFPUTSL(ob, "<div data-type=\"customblock prettyprint\" data-metadata=\"");
+			cls++;
+		} else {
+			BUFPUTSL(ob, "<div data-type=\"customblock\" data-metadata=\"");
+		}
+
+		for (i = 0, cls = 0; i < type->size; ++i, ++cls) {
+			while (i < type->size && isspace(type->data[i]))
+				i++;
+
+			if (i < type->size) {
+				size_t org = i;
+				while (i < type->size && is_non_space(type->data[i]))
+					i++;
+
+				if (type->data[org] == '.')
+					org++;
+
+				if (cls) bufputc(ob, ' ');
+				escape_html(ob, type->data + org, i - org);
+			}
+		}
+
+		BUFPUTSL(ob, "\">");
+	} else if (options->flags & HTML_PRETTIFY) {
+		BUFPUTSL(ob, "<div data-type=\"customblock prettyprint\">");
+	} else {
+		BUFPUTSL(ob, "<div data-type=\"customblock\">");
+	}
+
+	if (text)
+		escape_html(ob, text->data, text->size);
+
+	BUFPUTSL(ob, "</div>\n");
+}
+
 static void
 rndr_blockcode(struct buf *ob, const struct buf *text, const struct buf *lang, void *opaque)
 {
@@ -749,6 +795,7 @@ sdhtml_toc_renderer(struct sd_callbacks *callbacks, struct html_renderopt *optio
 		NULL,
 		NULL,
 		NULL,
+		NULL,
 		toc_header,
 		NULL,
 		NULL,
@@ -794,6 +841,7 @@ sdhtml_renderer(struct sd_callbacks *callbacks, struct html_renderopt *options,
 {
 	static const struct sd_callbacks cb_default = {
 		rndr_blockcode,
+		rndr_blockcustom,
 		rndr_blockquote,
 		rndr_raw_block,
 		rndr_header,

data/ext/greenmat/markdown.c

@@ -1442,6 +1442,37 @@ prefix_codefence(uint8_t *data, size_t size)
 	return i;
 }
 
+/* check if a line begins with a custom fence; return the
+ * width of the custom fence */
+static size_t
+prefix_customfence(uint8_t *data, size_t size)
+{
+	size_t i = 0, n = 0;
+	uint8_t c;
+
+	/* skipping initial spaces */
+	if (size < 3) return 0;
+	if (data[0] == ' ') { i++;
+	if (data[1] == ' ') { i++;
+	if (data[2] == ' ') { i++; } } }
+
+	/* looking at the hrule uint8_t */
+	if (i + 2 >= size || !(data[i] == ':'))
+		return 0;
+
+	c = data[i];
+
+	/* the whole line must be the uint8_t or whitespace */
+	while (i < size && data[i] == c) {
+		n++; i++;
+	}
+
+	if (n < 3)
+		return 0;
+
+	return i;
+}
+
 /* check if a line is a code fence; return its size if it is */
 static size_t
 is_codefence(uint8_t *data, size_t size, struct buf *syntax)
@@ -1499,6 +1530,63 @@ is_codefence(uint8_t *data, size_t size, struct buf *syntax)
 	return i + 1;
 }
 
+/* check if a line is a custom fence; return its size if it is */
+static size_t
+is_customfence(uint8_t *data, size_t size, struct buf *syntax)
+{
+	size_t i = 0, syn_len = 0;
+	uint8_t *syn_start;
+
+	i = prefix_customfence(data, size);
+	if (i == 0)
+		return 0;
+
+	while (i < size && data[i] == ' ')
+		i++;
+
+	syn_start = data + i;
+
+	if (i < size && data[i] == '{') {
+		i++; syn_start++;
+
+		while (i < size && data[i] != '}' && data[i] != '\n') {
+			syn_len++; i++;
+		}
+
+		if (i == size || data[i] != '}')
+			return 0;
+
+		/* strip all whitespace at the beginning and the end
+		 * of the {} block */
+		while (syn_len > 0 && _isspace(syn_start[0])) {
+			syn_start++; syn_len--;
+		}
+
+		while (syn_len > 0 && _isspace(syn_start[syn_len - 1]))
+			syn_len--;
+
+		i++;
+	} else {
+		while (i < size && data[i] != '\n') {
+			syn_len++; i++;
+		}
+	}
+
+	if (syntax) {
+		syntax->data = syn_start;
+		syntax->size = syn_len;
+	}
+
+	while (i < size && data[i] != '\n') {
+		if (!_isspace(data[i]))
+			return 0;
+
+		i++;
+	}
+
+	return i + 1;
+}
+
 /* is_atxheader • returns whether the line is a hash-prefixed header */
 static int
 is_atxheader(struct sd_markdown *rndr, uint8_t *data, size_t size)
@@ -1877,6 +1965,53 @@ parse_blockcode(struct buf *ob, struct sd_markdown *rndr, uint8_t *data, size_t
 	return beg;
 }
 
+
+
+/* parse_fencedcustom • handles parsing of a block-level custom fragment */
+static size_t
+parse_fencedcustom(struct buf *ob, struct sd_markdown *rndr, uint8_t *data, size_t size)
+{
+	size_t beg, end;
+	struct buf *work = 0;
+	struct buf type = { 0, 0, 0, 0 };
+
+	beg = is_customfence(data, size, &type);
+	if (beg == 0) return 0;
+
+	work = rndr_newbuf(rndr, BUFFER_BLOCK);
+
+	while (beg < size) {
+		size_t fence_end;
+		struct buf fence_trail = { 0, 0, 0, 0 };
+
+		fence_end = is_customfence(data + beg, size - beg, &fence_trail);
+		if (fence_end != 0 && fence_trail.size == 0) {
+			beg += fence_end;
+			break;
+		}
+
+		for (end = beg + 1; end < size && data[end - 1] != '\n'; end++);
+
+		if (beg < end) {
+			/* verbatim copy to the working buffer,
+				escaping entities */
+			if (is_empty(data + beg, end - beg))
+				bufputc(work, '\n');
+			else bufput(work, data + beg, end - beg);
+		}
+		beg = end;
+	}
+
+	if (work->size && work->data[work->size - 1] != '\n')
+		bufputc(work, '\n');
+
+	if (rndr->cb.blockcustom)
+		rndr->cb.blockcustom(ob, work, type.size ? &type : NULL, rndr->opaque);
+
+	rndr_popbuf(rndr, BUFFER_BLOCK);
+	return beg;
+}
+
 /* parse_listitem • parsing of a single list item */
 /*	assuming initial prefix is already removed */
 static size_t
@@ -2513,6 +2648,10 @@ parse_block(struct buf *ob, struct sd_markdown *rndr, uint8_t *data, size_t size
 			(i = parse_fencedcode(ob, rndr, txt_data, end)) != 0)
 			beg += i;
 
+		else if ((rndr->ext_flags & MKDEXT_FENCED_CUSTOM) != 0 &&
+			(i = parse_fencedcustom(ob, rndr, txt_data, end)) != 0)
+			beg += i;
+
 		else if ((rndr->ext_flags & MKDEXT_TABLES) != 0 &&
 			(i = parse_table(ob, rndr, txt_data, end)) != 0)
 			beg += i;

data/ext/greenmat/markdown.h

@@ -64,13 +64,15 @@ enum mkd_extensions {
 	MKDEXT_HIGHLIGHT = (1 << 10),
 	MKDEXT_FOOTNOTES = (1 << 11),
 	MKDEXT_QUOTE = (1 << 12),
-	MKDEXT_NO_MENTION_EMPHASIS = (1 << 13)
+	MKDEXT_NO_MENTION_EMPHASIS = (1 << 13),
+	MKDEXT_FENCED_CUSTOM = (1 << 14)
 };
 
 /* sd_callbacks - functions for rendering parsed data */
 struct sd_callbacks {
 	/* block level callbacks - NULL skips the block */
 	void (*blockcode)(struct buf *ob, const struct buf *text, const struct buf *lang, void *opaque);
+	void (*blockcustom)(struct buf *ob, const struct buf *text, const struct buf *type, void *opaque);
 	void (*blockquote)(struct buf *ob, const struct buf *text, void *opaque);
 	void (*blockhtml)(struct buf *ob,const  struct buf *text, void *opaque);
 	void (*header)(struct buf *ob, const struct buf *text, int level, void *opaque);

data/lib/greenmat/version.rb

@@ -1,3 +1,3 @@
 module Greenmat
-  VERSION = '3.5.1.1'
+  VERSION = '3.5.1.2'
 end

data/spec/greenmat/markdown_spec.rb

@@ -184,5 +184,48 @@ module Greenmat
         EOS
       end
     end
+
+    context 'with fenced_custom_blocks option' do
+      let(:options) { { fenced_custom_blocks: true } }
+
+      context 'with custom block with any metadata' do
+        let(:text) do
+          <<-EOS.strip_heredoc
+            :::foo bar
+            message
+            :::
+          EOS
+        end
+
+        it 'renders text with <div> tag that have customblock class & metadata in a data-metadata attribute' do
+          expect(rendered_html).to eq <<-EOS.strip_heredoc
+            <div data-type="customblock" data-metadata="foo bar">message
+            </div>
+          EOS
+        end
+      end
+    end
+
+    context 'without fenced_custom_blocks option' do
+      let(:options) { {} }
+
+      context 'with custom block with any metadata' do
+        let(:text) do
+          <<-EOS.strip_heredoc
+            :::foo bar
+            message
+            :::
+          EOS
+        end
+
+        it 'renders text with p tag' do
+          expect(rendered_html).to eq <<-EOS.strip_heredoc
+            <p>:::foo bar
+            message
+            :::</p>
+          EOS
+        end
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: greenmat
 version: !ruby/object:Gem::Version
-  version: 3.5.1.1
+  version: 3.5.1.2
 platform: ruby
 authors:
 - Natacha Porté
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -261,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: A Markdown parser for Qiita, based on Redcarpet.