commonmarker 0.21.2 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac3365deb1dd8288503331626fc20ec583a5f96a23e25d330f4ff47e526bfc54
-  data.tar.gz: 975bcb958eb2e994a15090311088ff95870af95b1fc2d73bc1c4eb216fe69388
+  metadata.gz: f5356237deaf85df9914e0c7fa3f121fa0301579653b83b006df4dd8404c65f2
+  data.tar.gz: 9d4a09830e1c107dec28e47a3c0ab96f2cc6bcd9786982e38607752022ec12f1
 SHA512:
-  metadata.gz: 531cda0280a75a40c139969287106646c8b2cef181b48249055f3a896bc4329485a0f70ac59f6f3a85eed00247c15f4a6785f478b957ebd3594be3074a9d25a9
-  data.tar.gz: 3bb88a326ea1e0e7f99da2b459b90cac2ea748e57d933029c11278f230064a433a00889c93d65851dfef4b131ba46562a33d4597ef677f3e382325a712b0ffe6
+  metadata.gz: 7e43f365eb266fa8c0627572999a2102df7dd65e0404917c5fa6054b532c526a35ad5d0ef9423cf68033edc52fb0c20da79ca73d7345b04d4493f33bff35ed73
+  data.tar.gz: 0e5da729c2247288a1bf60672f572f785def6e2a1726afeaf87aa1332d083e4834d52c403479a36437f9c0a9e99548569f7d5bc092a405304ccef81ac71096b1

data/README.md

@@ -1,6 +1,6 @@
 # CommonMarker
 
-[![Build Status](https://travis-ci.org/gjtorikian/commonmarker.svg)](https://travis-ci.org/gjtorikian/commonmarker) [![Gem Version](https://badge.fury.io/rb/commonmarker.svg)](http://badge.fury.io/rb/commonmarker)
+![Build Status](https://github.com/gjtorikian/commonmarker/workflows/CI/badge.svg) [![Gem Version](https://badge.fury.io/rb/commonmarker.svg)](http://badge.fury.io/rb/commonmarker)
 
 Ruby wrapper for [libcmark-gfm](https://github.com/github/cmark),
 GitHub's fork of the reference parser for CommonMark. It passes all of the C tests, and is therefore spec-complete. It also includes extensions to the CommonMark spec as documented in the [GitHub Flavored Markdown spec](http://github.github.com/gfm/), such as support for tables, strikethroughs, and autolinking.

data/bin/commonmarker

@@ -13,8 +13,8 @@ $LOAD_PATH.unshift File.expand_path('lib', root)
 def parse_options
   options = OpenStruct.new
   extensions = CommonMarker.extensions
-  parse_options = CommonMarker::Config::Parse
-  render_options = CommonMarker::Config::Render
+  parse_options = CommonMarker::Config::OPTS.fetch(:parse)
+  render_options = CommonMarker::Config::OPTS.fetch(:render)
 
   options.active_extensions = []
   options.active_parse_options = [:DEFAULT]

data/commonmarker.gemspec

@@ -21,12 +21,10 @@ Gem::Specification.new do |s|
 
   s.executables = ['commonmarker']
   s.require_paths = %w[lib ext]
-  s.required_ruby_version = ['>= 2.4.10', '< 4.0']
+  s.required_ruby_version = ['>= 2.6', '< 4.0']
 
   s.rdoc_options += ['-x', 'ext/commonmarker/cmark/.*']
 
-  s.add_dependency 'ruby-enum', '~> 0.5'
-
   s.add_development_dependency 'awesome_print'
   s.add_development_dependency 'json', '~> 2.3'
   s.add_development_dependency 'minitest', '~> 5.6'

data/ext/commonmarker/commonmarker.c

@@ -45,6 +45,13 @@ static VALUE encode_utf8_string(const char *c_string) {
   return string;
 }
 
+/* Encode a C string using the encoding from Ruby string +source+. */
+static VALUE encode_source_string(const char *c_string, VALUE source) {
+  VALUE string = rb_str_new2(c_string);
+  rb_enc_copy(string, source);
+  return string;
+}
+
 static void rb_mark_c_struct(void *data) {
   cmark_node *node = data;
   cmark_node *child;
@@ -1130,7 +1137,8 @@ static VALUE rb_html_escape_href(VALUE self, VALUE rb_text) {
   if (houdini_escape_href(&buf, (const uint8_t *)RSTRING_PTR(rb_text),
                           RSTRING_LEN(rb_text))) {
     result = (char *)cmark_strbuf_detach(&buf);
-    return rb_str_new2(result);
+    return encode_source_string(result, rb_text);
+
   }
 
   return rb_text;
@@ -1150,7 +1158,7 @@ static VALUE rb_html_escape_html(VALUE self, VALUE rb_text) {
   if (houdini_escape_html0(&buf, (const uint8_t *)RSTRING_PTR(rb_text),
                            RSTRING_LEN(rb_text), 0)) {
     result = (char *)cmark_strbuf_detach(&buf);
-    return rb_str_new2(result);
+    return encode_source_string(result, rb_text);
   }
 
   return rb_text;

data/lib/commonmarker/config.rb

@@ -1,55 +1,46 @@
 # frozen_string_literal: true
 
-require 'ruby-enum'
 module CommonMarker
   # For Ruby::Enum, these must be classes, not modules
   module Config
-    class Parse
-      include Ruby::Enum
-
-      define :DEFAULT, 0
-      define :VALIDATE_UTF8, (1 << 9)
-      define :SMART, (1 << 10)
-      define :LIBERAL_HTML_TAG, (1 << 12)
-      define :FOOTNOTES, (1 << 13)
-      define :STRIKETHROUGH_DOUBLE_TILDE, (1 << 14)
-      define :UNSAFE, (1 << 17)
-    end
-
-    class Render
-      include Ruby::Enum
-
-      define :DEFAULT, 0
-      define :SOURCEPOS, (1 << 1)
-      define :HARDBREAKS, (1 << 2)
-      define :NOBREAKS, (1 << 4)
-      define :GITHUB_PRE_LANG, (1 << 11)
-      define :TABLE_PREFER_STYLE_ATTRIBUTES, (1 << 15)
-      define :FULL_INFO_STRING, (1 << 16)
-      define :UNSAFE, (1 << 17)
-      define :FOOTNOTES, (1 << 13)
-    end
+    # See https://github.com/github/cmark-gfm/blob/master/src/cmark-gfm.h#L673
+    OPTS = {
+      parse: {
+        DEFAULT: 0,
+        VALIDATE_UTF8: (1 << 9),
+        SMART: (1 << 10),
+        LIBERAL_HTML_TAG: (1 << 12),
+        FOOTNOTES: (1 << 13),
+        STRIKETHROUGH_DOUBLE_TILDE: (1 << 14),
+        UNSAFE: (1 << 17)
+      }.freeze,
+      render: {
+        DEFAULT: 0,
+        SOURCEPOS: (1 << 1),
+        HARDBREAKS: (1 << 2),
+        NOBREAKS: (1 << 4),
+        GITHUB_PRE_LANG: (1 << 11),
+        TABLE_PREFER_STYLE_ATTRIBUTES: (1 << 15),
+        FULL_INFO_STRING: (1 << 16),
+        UNSAFE: (1 << 17),
+        FOOTNOTES: (1 << 13)
+      }.freeze
+    }.freeze
 
     def self.process_options(option, type)
-      type = Config.const_get(type.capitalize)
       case option
       when Symbol
-        check_option(option, type)
-        type.to_h[option]
+        OPTS.fetch(type).fetch(option)
       when Array
-        option = [nil] if option.empty?
+        raise TypeError if option.none?
+
         # neckbearding around. the map will both check the opts and then bitwise-OR it
-        option.map do |o|
-          check_option(o, type)
-          type.to_h[o]
-        end.inject(0, :|)
+        OPTS.fetch(type).fetch_values(*option).inject(0, :|)
       else
-        raise TypeError, "option type must be a valid symbol or array of symbols within the #{type} context"
+        raise TypeError, "option type must be a valid symbol or array of symbols within the #{name}::OPTS[:#{type}] context"
       end
-    end
-
-    def self.check_option(option, type)
-      raise TypeError, "option ':#{option}' does not exist for #{type}" unless type.key?(option)
+    rescue KeyError => e
+      raise TypeError, "option ':#{e.key}' does not exist for #{name}::OPTS[:#{type}]"
     end
   end
 end

data/lib/commonmarker/node/inspect.rb

@@ -27,11 +27,9 @@ module CommonMarker
             list_tight
             fence_info
           ].map do |name|
-            begin
-              [name, __send__(name)]
-            rescue NodeError
-              nil
-            end
+            [name, __send__(name)]
+          rescue NodeError
+            nil
           end.compact
 
           printer.seplist(attrs) do |name, value|

data/lib/commonmarker/renderer.rb

@@ -129,7 +129,7 @@ module CommonMarker
     end
 
     def option_enabled?(opt)
-      (@opts & CommonMarker::Config::Render.value(opt)) != 0
+      (@opts & CommonMarker::Config::OPTS.dig(:render, opt)) != 0
     end
   end
 end

data/lib/commonmarker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CommonMarker
-  VERSION = '0.21.2'
+  VERSION = '0.22.0'
 end

data/test/test_maliciousness.rb

@@ -70,7 +70,7 @@ module CommonMarker
       err = assert_raises TypeError do
         CommonMarker.render_html("foo \n baz", [:SMART])
       end
-      assert_equal('option \':SMART\' does not exist for CommonMarker::Config::Render', err.message)
+      assert_equal('option \':SMART\' does not exist for CommonMarker::Config::OPTS[:render]', err.message)
 
       assert_raises TypeError do
         CommonMarker.render_doc("foo \n baz", 123)
@@ -79,7 +79,7 @@ module CommonMarker
       err = assert_raises TypeError do
         CommonMarker.render_doc("foo \n baz", :safe)
       end
-      assert_equal('option \':safe\' does not exist for CommonMarker::Config::Parse', err.message)
+      assert_equal('option \':safe\' does not exist for CommonMarker::Config::OPTS[:parse]', err.message)
 
       assert_raises TypeError do
         CommonMarker.render_doc("foo \n baz", :totes_fake)

data/test/test_renderer.rb

@@ -27,4 +27,21 @@ class TestRenderer < Minitest::Test
     results = CommonMarker::HtmlRenderer.new.render(doc)
     assert_equal 2, results.scan(/<tbody>/).size
   end
+
+  def test_escape_html_encoding
+    my_renderer = Class.new(HtmlRenderer) do
+      attr_reader :input_encoding, :output_encoding
+
+      def text(node)
+        @input_encoding = node.string_content.encoding
+        escape_html(node.string_content).tap do |escaped|
+          @output_encoding = escaped.encoding
+        end
+      end
+    end
+
+    renderer = my_renderer.new
+    assert_equal Encoding::UTF_8, renderer.render(@doc).encoding
+    assert_equal renderer.input_encoding, renderer.output_encoding
+  end
 end

metadata

@@ -1,30 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: commonmarker
 version: !ruby/object:Gem::Version
-  version: 0.21.2
+  version: 0.22.0
 platform: ruby
 authors:
 - Garen Torikian
 - Ashe Connor
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-11 00:00:00.000000000 Z
+date: 2021-06-20 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: ruby-enum
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -153,7 +139,7 @@ dependencies:
         version: '0'
 description: A fast, safe, extensible parser for CommonMark. This wraps the official
   libcmark library.
-email: 
+email:
 executables:
 - commonmarker
 extensions:
@@ -272,7 +258,7 @@ homepage: https://github.com/gjtorikian/commonmarker
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "-x"
 - ext/commonmarker/cmark/.*
@@ -283,7 +269,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.10
+      version: '2.6'
   - - "<"
     - !ruby/object:Gem::Version
       version: '4.0'
@@ -294,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: CommonMark parser and renderer. Written in C, wrapped in Ruby.
 test_files: