qiita_marker 0.23.2.1 → 0.23.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0579157ad4abb4038246ef4dc4752fd1de6cd281daa619b2ef42adec5b147982'
-  data.tar.gz: c671815ff61ab460fcf6c3a42a614018a250c62ceaa41ee0aa3e899f34c12b16
+  metadata.gz: 15d5d73e2386cf310ae997adc33bfca334a51c241a0345b8d5fddc2af9a988bf
+  data.tar.gz: c45e0c3f30cfd5dfad5d8beb4dc0f3ee08fc6bb405e2dfb188623393180fa104
 SHA512:
-  metadata.gz: 32f16ce193b82d6a7214c851fdd81126d42d872fdd4508b798ccfc4faba4668793274f88f9ef25e61ae57545041d1062c65169b05cd756eec55df0aa042d0140
-  data.tar.gz: da050452749a3eee8d998db24aa45d6a8b1a282672283e427f8deca374405bfaebe572e954c7906ceb84bea2ff08ad737da05707b2ed5d378158d2738ac0e318
+  metadata.gz: 88d95a7228008d65a57f13d571370c3fe9a3701319e2e6a801a16659c032646d592345e155a23a8ac4f70b8d87a347b152a72b8447399c73285f2b475e3426d5
+  data.tar.gz: b3a3a996bfac4705044451fee3ecd7cd29909de05b3a1c9b52f64e9cc9cf14497820b8a74f67f49225c7ab777d87a83e9a0da104fa15219df03a3efb1c054a66

data/README.md

@@ -20,6 +20,7 @@ In addition to CommonMarker's options and extensions, the following are availabl
 | Name | Description |
 | --- | --- |
 | `:MENTION_NO_EMPHASIS` | Prevent parsing mentions as emphasis. |
+| `:AUTOLINK_CLASS_NAME` | Append `class="autolink"` to extension's autolinks. |
 
 #### Render options
 
@@ -27,6 +28,7 @@ In addition to CommonMarker's options and extensions, the following are availabl
 | --- | --- |
 | `:CODE_DATA_METADATA` | Use `<code data-metadata>` for fenced code blocks. |
 | `:MENTION_NO_EMPHASIS` | Prevent parsing mentions as emphasis. |
+| `:AUTOLINK_CLASS_NAME` | Append `class="autolink"` to extension's autolinks. |
 
 ### Original extensions
 

data/ext/qiita_marker/autolink.c

@@ -1,5 +1,9 @@
 #include "autolink.h"
+#include "houdini.h"
+#include "qfm.h"
+#include "scanners.h"
 #include <parser.h>
+#include <render.h>
 #include <string.h>
 #include <utf8.h>
 
@@ -9,6 +13,11 @@
 #include <strings.h>
 #endif
 
+static void escape_html(cmark_strbuf *dest, const unsigned char *source,
+                        bufsize_t length) {
+  houdini_escape_html0(dest, source, length, 0);
+}
+
 static int is_valid_hostchar(const uint8_t *link, size_t link_len) {
   int32_t ch;
   int r = cmark_utf8proc_iterate(link, (bufsize_t)link_len, &ch);
@@ -144,7 +153,8 @@ static size_t check_domain(uint8_t *data, size_t size, int allow_short) {
 }
 
 static cmark_node *www_match(cmark_parser *parser, cmark_node *parent,
-                             cmark_inline_parser *inline_parser) {
+                             cmark_inline_parser *inline_parser,
+                             cmark_syntax_extension *ext) {
   cmark_chunk *chunk = cmark_inline_parser_get_chunk(inline_parser);
   size_t max_rewind = cmark_inline_parser_get_offset(inline_parser);
   uint8_t *data = chunk->data + max_rewind;
@@ -176,6 +186,9 @@ static cmark_node *www_match(cmark_parser *parser, cmark_node *parent,
   cmark_inline_parser_set_offset(inline_parser, (int)(max_rewind + link_end));
 
   cmark_node *node = cmark_node_new_with_mem(CMARK_NODE_LINK, parser->mem);
+  if (parser->options & CMARK_OPT_AUTOLINK_CLASS_NAME) {
+    cmark_node_set_syntax_extension(node, ext);
+  }
 
   cmark_strbuf buf;
   cmark_strbuf_init(parser->mem, &buf, 10);
@@ -199,7 +212,8 @@ static cmark_node *www_match(cmark_parser *parser, cmark_node *parent,
 }
 
 static cmark_node *url_match(cmark_parser *parser, cmark_node *parent,
-                             cmark_inline_parser *inline_parser) {
+                             cmark_inline_parser *inline_parser,
+                             cmark_syntax_extension *ext) {
   size_t link_end, domain_len;
   int rewind = 0;
 
@@ -237,6 +251,9 @@ static cmark_node *url_match(cmark_parser *parser, cmark_node *parent,
   cmark_node_unput(parent, rewind);
 
   cmark_node *node = cmark_node_new_with_mem(CMARK_NODE_LINK, parser->mem);
+  if (parser->options & CMARK_OPT_AUTOLINK_CLASS_NAME) {
+    cmark_node_set_syntax_extension(node, ext);
+  }
 
   cmark_chunk url = cmark_chunk_dup(chunk, max_rewind - rewind,
                                     (bufsize_t)(link_end + rewind));
@@ -257,10 +274,10 @@ static cmark_node *match(cmark_syntax_extension *ext, cmark_parser *parser,
     return NULL;
 
   if (c == ':')
-    return url_match(parser, parent, inline_parser);
+    return url_match(parser, parent, inline_parser, ext);
 
   if (c == 'w')
-    return www_match(parser, parent, inline_parser);
+    return www_match(parser, parent, inline_parser, ext);
 
   return NULL;
 
@@ -269,7 +286,8 @@ static cmark_node *match(cmark_syntax_extension *ext, cmark_parser *parser,
   // inline was finished in inlines.c.
 }
 
-static void postprocess_text(cmark_parser *parser, cmark_node *text, int offset, int depth) {
+static void postprocess_text(cmark_parser *parser, cmark_node *text, int offset,
+                             int depth, cmark_syntax_extension *ext) {
   // postprocess_text can recurse very deeply if there is a very long line of
   // '@' only.  Stop at a reasonable depth to ensure it cannot crash.
   if (depth > 1000) return;
@@ -311,7 +329,7 @@ static void postprocess_text(cmark_parser *parser, cmark_node *text, int offset,
   }
 
   if (rewind == 0 || ns > 0) {
-    postprocess_text(parser, text, max_rewind + 1 + offset, depth + 1);
+    postprocess_text(parser, text, max_rewind + 1 + offset, depth + 1, ext);
     return;
   }
 
@@ -331,20 +349,23 @@ static void postprocess_text(cmark_parser *parser, cmark_node *text, int offset,
 
   if (link_end < 2 || nb != 1 || np == 0 ||
       (!cmark_isalpha(data[link_end - 1]) && data[link_end - 1] != '.')) {
-    postprocess_text(parser, text, max_rewind + 1 + offset, depth + 1);
+    postprocess_text(parser, text, max_rewind + 1 + offset, depth + 1, ext);
     return;
   }
 
   link_end = autolink_delim(data, link_end);
 
   if (link_end == 0) {
-    postprocess_text(parser, text, max_rewind + 1 + offset, depth + 1);
+    postprocess_text(parser, text, max_rewind + 1 + offset, depth + 1, ext);
     return;
   }
 
   cmark_chunk_to_cstr(parser->mem, &text->as.literal);
 
   cmark_node *link_node = cmark_node_new_with_mem(CMARK_NODE_LINK, parser->mem);
+  if (parser->options & CMARK_OPT_AUTOLINK_CLASS_NAME) {
+    cmark_node_set_syntax_extension(link_node, ext);
+  }
   cmark_strbuf buf;
   cmark_strbuf_init(parser->mem, &buf, 10);
   cmark_strbuf_puts(&buf, "mailto:");
@@ -373,7 +394,7 @@ static void postprocess_text(cmark_parser *parser, cmark_node *text, int offset,
   text->as.literal.len = offset + max_rewind - rewind;
   text->as.literal.data[text->as.literal.len] = 0;
 
-  postprocess_text(parser, post, 0, depth + 1);
+  postprocess_text(parser, post, 0, depth + 1, ext);
 }
 
 static cmark_node *postprocess(cmark_syntax_extension *ext, cmark_parser *parser, cmark_node *root) {
@@ -400,7 +421,7 @@ static cmark_node *postprocess(cmark_syntax_extension *ext, cmark_parser *parser
     }
 
     if (ev == CMARK_EVENT_ENTER && node->type == CMARK_NODE_TEXT) {
-      postprocess_text(parser, node, 0, /*depth*/0);
+      postprocess_text(parser, node, 0, /*depth*/ 0, ext);
     }
   }
 
@@ -409,12 +430,38 @@ static cmark_node *postprocess(cmark_syntax_extension *ext, cmark_parser *parser
   return root;
 }
 
+static void html_render(cmark_syntax_extension *extension,
+                        cmark_html_renderer *renderer, cmark_node *node,
+                        cmark_event_type ev_type, int options) {
+  bool entering = (ev_type == CMARK_EVENT_ENTER);
+  cmark_strbuf *html = renderer->html;
+
+  if (entering) {
+    cmark_strbuf_puts(html, "<a href=\"");
+    if ((options & CMARK_OPT_UNSAFE) ||
+        !(scan_dangerous_url(&node->as.link.url, 0))) {
+      houdini_escape_href(html, node->as.link.url.data, node->as.link.url.len);
+    }
+    if (node->as.link.title.len) {
+      cmark_strbuf_puts(html, "\" title=\"");
+      escape_html(html, node->as.link.title.data, node->as.link.title.len);
+    }
+    if (options & CMARK_OPT_AUTOLINK_CLASS_NAME) {
+      cmark_strbuf_puts(html, "\" class=\"autolink");
+    }
+    cmark_strbuf_puts(html, "\">");
+  } else {
+    cmark_strbuf_puts(html, "</a>");
+  }
+}
+
 cmark_syntax_extension *create_autolink_extension(void) {
   cmark_syntax_extension *ext = cmark_syntax_extension_new("autolink");
   cmark_llist *special_chars = NULL;
 
   cmark_syntax_extension_set_match_inline_func(ext, match);
   cmark_syntax_extension_set_postprocess_func(ext, postprocess);
+  cmark_syntax_extension_set_html_render_func(ext, html_render);
 
   cmark_mem *mem = cmark_get_default_mem_allocator();
   special_chars = cmark_llist_append(mem, special_chars, (void *)':');

data/ext/qiita_marker/html.c

@@ -227,7 +227,7 @@ static int S_render_node(cmark_html_renderer *renderer, cmark_node *node,
         cmark_strbuf_puts(html, "<pre");
         cmark_html_render_sourcepos(node, html, options);
         cmark_strbuf_puts(html, "><code data-metadata=\"");
-        escape_html(html, node->as.code.info.data, first_tag);
+        escape_html(html, node->as.code.info.data, node->as.code.info.len);
         if (first_tag < node->as.code.info.len &&
             (options & CMARK_OPT_FULL_INFO_STRING)) {
           cmark_strbuf_puts(html, "\" data-meta=\"");

data/ext/qiita_marker/qfm.h

@@ -12,6 +12,9 @@ extern "C" {
 /* Prevent parsing Qiita-style Mentions as emphasis. */
 #define CMARK_OPT_MENTION_NO_EMPHASIS (1 << 26)
 
+/* Render autolinks with class name  */
+#define CMARK_OPT_AUTOLINK_CLASS_NAME (1 << 27)
+
 #ifdef __cplusplus
 }
 #endif

data/ext/qiita_marker/qfm_custom_block.c

@@ -157,20 +157,7 @@ static int can_contain(cmark_syntax_extension *self, cmark_node *node,
                        cmark_node_type child_type) {
   cmark_node_type node_type = cmark_node_get_type(node);
 
-  if (node_type == CMARK_NODE_QFM_CUSTOM_BLOCK) {
-    return
-        // Block
-        child_type == CMARK_NODE_LIST || child_type == CMARK_NODE_PARAGRAPH ||
-        // Inline
-        child_type == CMARK_NODE_TEXT || child_type == CMARK_NODE_CODE ||
-        child_type == CMARK_NODE_HTML_INLINE || child_type == CMARK_NODE_EMPH ||
-        child_type == CMARK_NODE_STRONG || child_type == CMARK_NODE_LINK ||
-        child_type == CMARK_NODE_IMAGE ||
-        child_type == CMARK_NODE_FOOTNOTE_REFERENCE ||
-        child_type == CMARK_NODE_STRIKETHROUGH;
-  }
-
-  return 0;
+  return node_type == CMARK_NODE_QFM_CUSTOM_BLOCK;
 }
 
 static int contains_inlines(cmark_syntax_extension *self, cmark_node *node) {

data/ext/qiita_marker/qfm_mention_no_emphasis.c

@@ -1,5 +1,5 @@
-#include "cmark_ctype.h"
 #include "cmark-gfm.h"
+#include "cmark_ctype.h"
 #include "config.h"
 
 static bool is_wordchar(char c) {

data/lib/qiita_marker/config.rb

@@ -14,7 +14,8 @@ module QiitaMarker
         LIBERAL_HTML_TAG: (1 << 12),
         FOOTNOTES: (1 << 13),
         STRIKETHROUGH_DOUBLE_TILDE: (1 << 14),
-        MENTION_NO_EMPHASIS: (1 << 26)
+        MENTION_NO_EMPHASIS: (1 << 26),
+        AUTOLINK_CLASS_NAME: (1 << 27)
       }.freeze,
       render: {
         DEFAULT: 0,
@@ -31,7 +32,8 @@ module QiitaMarker
         TABLE_PREFER_STYLE_ATTRIBUTES: (1 << 15),
         FULL_INFO_STRING: (1 << 16),
         CODE_DATA_METADATA: (1 << 25),
-        MENTION_NO_EMPHASIS: (1 << 26)
+        MENTION_NO_EMPHASIS: (1 << 26),
+        AUTOLINK_CLASS_NAME: (1 << 27)
       }.freeze,
       format: %i[html xml commonmark plaintext].freeze
     }.freeze

data/lib/qiita_marker/renderer/html_renderer.rb

@@ -96,7 +96,7 @@ module QiitaMarker
           out('><code>')
         elsif option_enabled?(:CODE_DATA_METADATA)
           out("<pre#{sourcepos(node)}><code")
-          out(' data-metadata="', node.fence_info.split(/\s+/)[0], '"') if node.fence_info && !node.fence_info.empty?
+          out(' data-metadata="', node.fence_info, '"') if node.fence_info && !node.fence_info.empty?
           out('>')
         else
           out("<pre#{sourcepos(node)}><code")

data/lib/qiita_marker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QiitaMarker
-  VERSION = '0.23.2.1'
+  VERSION = '0.23.2.2'
 end

data/test/test_qfm_autolink_class_name.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require('test_helper')
+
+describe 'TestQfmAutolinkClassName' do
+  let(:options) { %i[AUTOLINK_CLASS_NAME] }
+  let(:extensions) { %i[autolink] }
+  let(:text) do
+    <<~MD
+      https://example.com
+      <https://example.com>
+      [Example](https://example.com)
+      test@example.com
+    MD
+  end
+  let(:doc) { QiitaMarker.render_doc(text, options, extensions) }
+  let(:expected) do
+    <<~HTML
+      <p><a href="https://example.com" class="autolink">https://example.com</a>
+      <a href="https://example.com">https://example.com</a>
+      <a href="https://example.com">Example</a>
+      <a href="mailto:test@example.com" class="autolink">test@example.com</a></p>
+    HTML
+  end
+  let(:rendered_html) { doc.to_html(options, extensions) }
+
+  it "appends class name to extension's autolinks" do
+    assert_equal(expected, rendered_html)
+  end
+
+  describe 'without AUTOLINK_CLASS_NAME option' do
+    let(:options) { %i[DEFAULT] }
+    let(:expected) do
+      <<~HTML
+        <p><a href="https://example.com">https://example.com</a>
+        <a href="https://example.com">https://example.com</a>
+        <a href="https://example.com">Example</a>
+        <a href="mailto:test@example.com">test@example.com</a></p>
+      HTML
+    end
+
+    it "does not append class name to extension's autolink" do
+      assert_equal(expected, rendered_html)
+    end
+  end
+
+  describe 'without autolink extension' do
+    let(:extensions) { %i[] }
+    let(:expected) do
+      <<~HTML
+        <p>https://example.com
+        <a href="https://example.com">https://example.com</a>
+        <a href="https://example.com">Example</a>
+        test@example.com</p>
+      HTML
+    end
+
+    it 'does not append class name' do
+      assert_equal(expected, rendered_html)
+    end
+  end
+end

data/test/test_qfm_code_data_metadata.rb

@@ -3,24 +3,39 @@
 require('test_helper')
 
 class TestQfmCodeDataMetadata < Minitest::Test
-  def setup
+  def test_to_html
     text = <<~MD
-      ```ruby:example.rb
+      ```ruby:example main.rb
       puts :foo
       ```
     MD
-    @doc = QiitaMarker.render_doc(text, :DEFAULT, [])
-    @expected = <<~HTML
-      <pre><code data-metadata="ruby:example.rb">puts :foo
+    doc = render_doc(text)
+    expected = <<~HTML
+      <pre><code data-metadata="ruby:example main.rb">puts :foo
       </code></pre>
     HTML
+
+    assert_equal(expected, doc.to_html(:CODE_DATA_METADATA))
+    assert_equal(expected, QiitaMarker::HtmlRenderer.new(options: :CODE_DATA_METADATA).render(doc))
   end
 
-  def test_to_html
-    assert_equal(@expected, @doc.to_html(:CODE_DATA_METADATA))
+  def test_with_character_reference
+    text = <<~MD
+      ```ruby:example&#x20;main.rb
+      puts :foo
+      ```
+    MD
+    doc = render_doc(text)
+    expected = <<~HTML
+      <pre><code data-metadata="ruby:example main.rb">puts :foo
+      </code></pre>
+    HTML
+
+    assert_equal(expected, doc.to_html(:CODE_DATA_METADATA))
+    assert_equal(expected, QiitaMarker::HtmlRenderer.new(options: :CODE_DATA_METADATA).render(doc))
   end
 
-  def test_html_renderer
-    assert_equal(@expected, QiitaMarker::HtmlRenderer.new(options: :CODE_DATA_METADATA).render(@doc))
+  def render_doc(markdown)
+    QiitaMarker.render_doc(markdown, :DEFAULT, [])
   end
 end

data/test/test_qfm_custom_block.rb

@@ -7,17 +7,33 @@ class TestQfmCustomBlock < Minitest::Test
     text = <<~MD
       :::foo bar
       message
+
+      - list1
+      - list2
+
+      ```ruby
+      puts 'hello'
+      ```
+
+      <div>html block</div>
       :::
     MD
-    @doc = QiitaMarker.render_doc(text, :DEFAULT, %i[custom_block])
+    @doc = QiitaMarker.render_doc(text, %i[UNSAFE], %i[custom_block])
     @expected = <<~HTML
       <div data-type="customblock" data-metadata="foo bar">
       <p>message</p>
+      <ul>
+      <li>list1</li>
+      <li>list2</li>
+      </ul>
+      <pre><code class="language-ruby">puts 'hello'
+      </code></pre>
+      <div>html block</div>
       </div>
     HTML
   end
 
   def test_to_html
-    assert_equal(@expected, @doc.to_html(:DEFAULT, %i[custom_block]))
+    assert_equal(@expected, @doc.to_html(%i[UNSAFE], %i[custom_block]))
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qiita_marker
 version: !ruby/object:Gem::Version
-  version: 0.23.2.1
+  version: 0.23.2.2
 platform: ruby
 authors:
 - Qiita Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-08 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -257,6 +257,7 @@ files:
 - test/test_options.rb
 - test/test_pathological_inputs.rb
 - test/test_plaintext.rb
+- test/test_qfm_autolink_class_name.rb
 - test/test_qfm_code_data_metadata.rb
 - test/test_qfm_custom_block.rb
 - test/test_qfm_mention_no_emphasis.rb
@@ -317,6 +318,7 @@ test_files:
 - test/test_options.rb
 - test/test_pathological_inputs.rb
 - test/test_plaintext.rb
+- test/test_qfm_autolink_class_name.rb
 - test/test_qfm_code_data_metadata.rb
 - test/test_qfm_custom_block.rb
 - test/test_qfm_mention_no_emphasis.rb