commonmarkercomrak 0.23.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f803207ba4d7185dd0548bfe26becbd845dd817baef02db60e6e043b2f23ab6
+  data.tar.gz: 306fcd7ab108a5abecd91957c4526082174bf726e39057747cd50a54272c8d9b
+SHA512:
+  metadata.gz: 1fe651892de86863ef7952eddb142502556614b178e355d6e3fec15f83cb6cae4fee344fee613dcdc9363377d6ff181b12104df6625c38e1cb314b4e90a2cf99
+  data.tar.gz: 5565bb76fa680f53de593b9c3a2f493a36cddf5a9305046243040a71452609ef0d29bd849b1d4abac8a3d045d7a075da4d4c6d2f93bd3fe75758acfefcebee7a

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Garen J. Torikian
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,134 @@
+# CommonMarker
+
+![Build Status](https://github.com/gjtorikian/commonmarkercomrak/workflows/CI/badge.svg) [![Gem Version](https://badge.fury.io/rb/commonmarkercomrak.svg)](http://badge.fury.io/rb/commonmarkercomrak)
+
+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.
+
+For more information on available extensions, see [the documentation below](#extensions).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'commonmarkercomrak'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install commonmarkercomrak
+
+## Usage
+
+### Converting to HTML
+
+Call `render_html` on a string to convert it to HTML:
+
+``` ruby
+require 'commonmarkercomrak'
+CommonMarker.to_html('Hi *there*', :DEFAULT)
+# <p>Hi <em>there</em></p>\n
+```
+
+The second argument is optional--[see below](#options) for more information.
+
+## Options
+
+CommonMarker accepts the same options that CMark does, as symbols. Note that there is a distinction in CMark for "parse" options and "render" options, which are represented in the tables below.
+
+### Parse options
+
+| Name                          | Description
+| ----------------------------- | -----------
+| `:DEFAULT`                    | The default parsing system.
+| `:SOURCEPOS`                  | Include source position in nodes
+| `:UNSAFE`                     | Allow raw/custom HTML and unsafe links.
+| `:VALIDATE_UTF8`              | Replace illegal sequences with the replacement character `U+FFFD`.
+| `:SMART`                      | Use smart punctuation (curly quotes, etc.).
+| `:LIBERAL_HTML_TAG`           | Support liberal parsing of inline HTML tags.
+| `:FOOTNOTES`                  | Parse footnotes.
+| `:STRIKETHROUGH_DOUBLE_TILDE` | Parse strikethroughs by double tildes (compatibility with [redcarpet](https://github.com/vmg/redcarpet))
+
+### Render options
+
+| Name                             | Description                                                     |
+| ------------------               | -----------                                                     |
+| `:DEFAULT`                       | The default rendering system.                                   |
+| `:SOURCEPOS`                     | Include source position in rendered HTML.                       |
+| `:HARDBREAKS`                    | Treat `\n` as hardbreaks (by adding `<br/>`).                   |
+| `:UNSAFE`                        | Allow raw/custom HTML and unsafe links.                         |
+| `:NOBREAKS`                      | Translate `\n` in the source to a single whitespace.            |
+| `:VALIDATE_UTF8`                 | Replace illegal sequences with the replacement character `U+FFFD`. |
+| `:SMART`                         | Use smart punctuation (curly quotes, etc.).                     |
+| `:GITHUB_PRE_LANG`               | Use GitHub-style `<pre lang>` for fenced code blocks.           |
+| `:LIBERAL_HTML_TAG`              | Support liberal parsing of inline HTML tags.                    |
+| `:FOOTNOTES`                     | Render footnotes.                                               |
+| `:STRIKETHROUGH_DOUBLE_TILDE`    | Parse strikethroughs by double tildes (compatibility with [redcarpet](https://github.com/vmg/redcarpet)) |
+| `:TABLE_PREFER_STYLE_ATTRIBUTES` | Use `style` insted of `align` for table cells.                  |
+| `:FULL_INFO_STRING`              | Include full info strings of code blocks in separate attribute. |
+
+### Passing options
+
+To apply an option, pass it as part of the hash:
+
+``` ruby
+CommonMarker.to_html("\"Hello,\" said the spider.", :SMART)
+# <p>“Hello,” said the spider.</p>\n
+
+CommonMarker.to_html("\"'Shelob' is my name.\"", [:HARDBREAKS, :SOURCEPOS])
+```
+
+For more information on these options, see [the comrak documentation](https://github.com/kivikakk/comrak#usage).
+
+## Output formats
+
+CommonmarkerComrak can only generate output in one format: HTML.
+
+### HTML
+
+```ruby
+html = CommonMarker.to_html('*Hello* world!', :DEFAULT)
+puts(html)
+
+# <p><em>Hello</em> world!</p>
+```
+
+## Developing locally
+
+After cloning the repo:
+
+```
+script/bootstrap
+bundle exec rake compile
+```
+
+If there were no errors, you're done! Otherwise, make sure to follow the comrak dependency instructions.
+
+## Benchmarks
+
+Some rough benchmarks:
+
+```
+$ bundle exec rake benchmark
+
+input size = 11064832 bytes
+
+Warming up --------------------------------------
+           redcarpet     2.000  i/100ms
+commonmarkercomrak with to_html
+                         1.000  i/100ms
+            kramdown     1.000  i/100ms
+Calculating -------------------------------------
+           redcarpet     22.634  (± 4.4%) i/s -    114.000  in   5.054490s
+commonmarkercomrak with to_html
+                          7.340  (± 0.0%) i/s -     37.000  in   5.058352s
+            kramdown      0.343  (± 0.0%) i/s -      2.000  in   5.834208s
+
+Comparison:
+           redcarpet:       22.6 i/s
+commonmarkercomrak with to_html:        7.3 i/s - 3.08x  (± 0.00) slower
+            kramdown:        0.3 i/s - 66.02x  (± 0.00) slower
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Gem Spec
+require "bundler"
+COMMONMARKERCOMRAK_SPEC = Bundler.load_gemspec("commonmarkercomrak.gemspec")
+
+# Packaging
+require "bundler/gem_tasks"

data/commonmarkercomrak.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "commonmarkercomrak/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "commonmarkercomrak"
+  spec.version = CommonmarkerComrak::VERSION
+  spec.summary = "CommonMark parser and renderer. Written in Rust, wrapped in Ruby."
+  spec.description = "A fast, safe, extensible parser for CommonMark. This wraps the comrak Rust crate."
+  spec.authors = ["Garen Torikian", "Ashe Connor"]
+  spec.homepage = "https://github.com/gjtorikian/commonmarkercomrak"
+  spec.license = "MIT"
+
+  spec.files         = ["LICENSE.txt", "README.md", "Rakefile", "commonmarkercomrak.gemspec"]
+  spec.files        += Dir.glob("lib/**/*.rb")
+  spec.files        += Dir.glob("ext/commonmarkercomrak/*.*")
+  spec.extensions    = ["ext/commonmarkercomrak/extconf.rb"]
+
+  spec.require_paths = ["lib", "ext"]
+  spec.required_ruby_version = [">= 3.0", "< 4.0"]
+
+  spec.metadata = {
+    "funding_uri" => "https://github.com/sponsors/gjtorikian/",
+    "rubygems_mfa_required" => "true",
+  }
+
+  spec.add_development_dependency("awesome_print")
+  spec.add_development_dependency("debug") if "#{RbConfig::CONFIG["MAJOR"]}.#{RbConfig::CONFIG["MINOR"]}".to_f >= 3.1
+  spec.add_development_dependency("json", "~> 2.3")
+  spec.add_development_dependency("minitest", "~> 5.6")
+  spec.add_development_dependency("minitest-focus", "~> 1.1")
+  spec.add_development_dependency("nokogiri", "~> 1.13")
+  spec.add_development_dependency("rake")
+  spec.add_development_dependency("rake-compiler", "~> 0.9")
+  spec.add_development_dependency("rdoc", "~> 6.2")
+  spec.add_development_dependency("rubocop-standard")
+
+  spec.add_runtime_dependency("mini_portile2", "~> 2.8") # keep version in sync with extconf.rb
+end

data/ext/commonmarkercomrak/commonmarkercomrak.c

@@ -0,0 +1,149 @@
+#include "ruby.h"
+
+#include "commonmarkercomrak.h"
+
+#include "comrak_ffi.h"
+
+int iterate_extension_options(VALUE key, VALUE val, VALUE arg) {
+  comrak_options_t *config = (comrak_options_t *)arg;
+
+  if (key == ID2SYM(rb_intern("strikethrough"))) {
+    if (TYPE(val) == T_TRUE || TYPE(val) == T_FALSE) {
+      comrak_set_extension_option_strikethrough(config, val);
+    }
+  } else if (key == ID2SYM(rb_intern("tagfilter"))) {
+    if (TYPE(val) == T_TRUE || TYPE(val) == T_FALSE) {
+      comrak_set_extension_option_tagfilter(config, val);
+    }
+  } else if (key == ID2SYM(rb_intern("table"))) {
+    if (TYPE(val) == T_TRUE || TYPE(val) == T_FALSE) {
+      comrak_set_extension_option_table(config, val);
+    }
+  } else if (key == ID2SYM(rb_intern("autolink"))) {
+    if (TYPE(val) == T_TRUE || TYPE(val) == T_FALSE) {
+      comrak_set_extension_option_autolink(config, val);
+    }
+  } else if (key == ID2SYM(rb_intern("tasklist"))) {
+    if (TYPE(val) == T_TRUE || TYPE(val) == T_FALSE) {
+      comrak_set_extension_option_tasklist(config, val);
+    }
+  } else if (key == ID2SYM(rb_intern("superscript"))) {
+    if (TYPE(val) == T_TRUE || TYPE(val) == T_FALSE) {
+      comrak_set_extension_option_superscript(config, val);
+    }
+  } else if (key == ID2SYM(rb_intern("header_ids"))) {
+    Check_Type(val, T_STRING);
+    comrak_set_extension_option_header_ids(config, StringValuePtr(val),
+                                           RSTRING_LEN(val));
+  } else if (key == ID2SYM(rb_intern("footnotes"))) {
+    if (TYPE(val) == T_TRUE || TYPE(val) == T_FALSE) {
+      comrak_set_extension_option_footnotes(config, val);
+    }
+  } else if (key == ID2SYM(rb_intern("description_lists"))) {
+    if (TYPE(val) == T_TRUE || TYPE(val) == T_FALSE) {
+      comrak_set_extension_option_description_lists(config, val);
+    }
+  } else if (key == ID2SYM(rb_intern("front_matter_delimiter"))) {
+    Check_Type(val, T_STRING);
+    comrak_set_extension_option_front_matter_delimiter(
+        config, StringValuePtr(val), RSTRING_LEN(val));
+  }
+
+  return ST_CONTINUE;
+}
+
+int iterate_render_options(VALUE key, VALUE val, VALUE arg) {
+  comrak_options_t *config = (comrak_options_t *)arg;
+
+  if (key == ID2SYM(rb_intern("hardbreaks"))) {
+    if (TYPE(val) == T_TRUE || TYPE(val) == T_FALSE) {
+      comrak_set_render_option_hardbreaks(config, val);
+    }
+  } else if (key == ID2SYM(rb_intern("github_pre_lang"))) {
+    if (TYPE(val) == T_TRUE || TYPE(val) == T_FALSE) {
+      comrak_set_render_option_github_pre_lang(config, val);
+    }
+  } else if (key == ID2SYM(rb_intern("width"))) {
+    Check_Type(val, T_FIXNUM);
+    if (TYPE(val) == T_TRUE || TYPE(val) == T_FALSE) {
+      comrak_set_render_option_github_pre_lang(config, val);
+    }
+  } else if (key == ID2SYM(rb_intern("unsafe_"))) {
+    if (TYPE(val) == T_TRUE || TYPE(val) == T_FALSE) {
+      comrak_set_render_option_unsafe_(config, val);
+    }
+  } else if (key == ID2SYM(rb_intern("escape"))) {
+    if (TYPE(val) == T_TRUE || TYPE(val) == T_FALSE) {
+      comrak_set_render_option_escape(config, val);
+    }
+  }
+
+  return ST_CONTINUE;
+}
+
+int iterate_parse_options(VALUE key, VALUE val, VALUE arg) {
+  comrak_options_t *config = (comrak_options_t *)arg;
+
+  if (key == ID2SYM(rb_intern("smart"))) {
+    if (TYPE(val) == T_TRUE || TYPE(val) == T_FALSE) {
+      comrak_set_parse_option_smart(config, val);
+    }
+  } else if (key == ID2SYM(rb_intern("default_info_string"))) {
+    Check_Type(val, T_STRING);
+
+    comrak_set_parse_option_default_info_string(config, StringValuePtr(val),
+                                                RSTRING_LEN(val));
+  }
+
+  return ST_CONTINUE;
+}
+
+int iterate_options_hash(VALUE rb_option_key, VALUE rb_option_val, VALUE arg) {
+  comrak_options_t *config = (comrak_options_t *)arg;
+
+  Check_Type(rb_option_key, T_SYMBOL);
+
+  // which options are we dealing with?
+  if (rb_option_key == ID2SYM(rb_intern("parse"))) {
+    Check_Type(rb_option_val, T_HASH);
+    rb_hash_foreach(rb_option_val, iterate_parse_options, (VALUE)config);
+  } else if (rb_option_key == ID2SYM(rb_intern("render"))) {
+    Check_Type(rb_option_val, T_HASH);
+    rb_hash_foreach(rb_option_val, iterate_render_options, (VALUE)config);
+  } else if (rb_option_key == ID2SYM(rb_intern("extension"))) {
+    Check_Type(rb_option_val, T_HASH);
+    if (rb_hash_aref(rb_option_val, ID2SYM(rb_intern("header_ids"))) == Qnil) {
+      comrak_set_extension_option_header_ids(config, NULL, 0);
+    }
+    rb_hash_foreach(rb_option_val, iterate_extension_options, (VALUE)config);
+  }
+
+  return ST_CONTINUE;
+}
+
+VALUE commonmark_to_html(VALUE self, VALUE rb_commonmark, VALUE rb_options) {
+  Check_Type(rb_commonmark, T_STRING);
+  Check_Type(rb_options, T_HASH);
+
+  char *commonmark = StringValueCStr(rb_commonmark);
+
+  comrak_options_t *options = comrak_options_new();
+  rb_hash_foreach(rb_options, iterate_options_hash, (VALUE)options);
+
+  comrak_str_t html = comrak_commonmark_to_html(commonmark, options);
+
+  VALUE rb_html = rb_utf8_str_new(html.data, html.len);
+
+  comrak_options_free(options);
+  comrak_str_free(html);
+
+  return rb_html;
+}
+
+__attribute__((visibility("default"))) void Init_commonmarkercomrak() {
+  VALUE module;
+
+  module = rb_define_module("CommonmarkerComrak");
+  rb_define_singleton_method(module, "commonmark_to_html", commonmark_to_html,
+                             2);
+}

data/ext/commonmarkercomrak/commonmarkercomrak.h

@@ -0,0 +1,18 @@
+#ifndef COMMONMARKER_H
+#define COMMONMARKER_H
+
+#ifndef __MSXML_LIBRARY_DEFINED__
+#define __MSXML_LIBRARY_DEFINED__
+#endif
+
+#include "ruby.h"
+#include "ruby/encoding.h"
+
+#include "comrak_ffi.h"
+
+#define CSTR2SYM(s) (ID2SYM(rb_intern((s))))
+
+void Init_commonmarker();
+VALUE commonmark_to_html(VALUE self, VALUE rb_commonmark, VALUE rb_options);
+
+#endif

data/ext/commonmarkercomrak/extconf.rb

@@ -0,0 +1,73 @@
+require "mkmf"
+require "mini_portile2"
+
+windows = RUBY_PLATFORM =~ /mingw|mswin/
+windows_ucrt = RUBY_PLATFORM =~ /(mingw|mswin).*ucrt/
+bsd = RUBY_PLATFORM =~ /bsd/
+darwin = RUBY_PLATFORM =~ /darwin/
+linux = RUBY_PLATFORM =~ /linux/
+cross_compiling = ENV['RCD_HOST_RUBY_VERSION'] # set by rake-compiler-dock in build containers
+# TruffleRuby uses the Sulong LLVM runtime, which is different from Apple's.
+apple_toolchain = darwin && RUBY_ENGINE != 'truffleruby'
+
+GEM_ROOT_DIR = File.expand_path(File.join(File.dirname(__FILE__), "..", ".."))
+EXT_DIR = File.join(GEM_ROOT_DIR, "ext", "commonmarkercomrak")
+CROSS_BUILD_P = enable_config("cross-build")
+
+RbConfig::CONFIG["CC"] = RbConfig::MAKEFILE_CONFIG["CC"] = ENV["CC"] if ENV["CC"]
+ENV["CC"] = RbConfig::CONFIG["CC"]
+
+# what follows is pretty much an abuse of miniportile2, but it works for now
+# i just need something to download files and run a cargo build; one day this should
+# be replaced with actual prepacked binaries.
+USER = "kivikakk"
+# COMRAK_VERSION = "0.14.0"
+COMRAK_VERSION = "main"
+# TARBALL_URL = "https://github.com/#{USER}/comrak/archive/refs/tags/#{COMRAK_VERSION}.tar.gz"
+TARBALL_URL = "https://github.com/#{USER}/comrak/archive/refs/heads/#{COMRAK_VERSION}.tar.gz"
+
+MiniPortile.new("comrak", COMRAK_VERSION).tap do |recipe|
+  recipe.target = File.join(GEM_ROOT_DIR, "ports")
+  recipe.files = [{
+    url: TARBALL_URL,
+    # sha256: "055fa44ef002a1a07853d3a4dd2a8c553a1dc58ff3809b4fa530ed35694d8571",
+  }]
+
+  # configure the environment that MiniPortile will use for subshells
+  if CROSS_BUILD_P
+    ENV.to_h.tap do |env|
+      # -fPIC is necessary for linking into a shared library
+      env["CFLAGS"] = [env["CFLAGS"], "-fPIC"].join(" ")
+
+      recipe.configure_options += env.map { |key, value| "#{key}=#{value.strip}" }
+    end
+  end
+
+  unless File.exist?(File.join(recipe.target, recipe.host, recipe.name, recipe.version))
+    recipe.download unless recipe.downloaded?
+    recipe.extract
+
+    tarball_extract_path = File.join("tmp", recipe.host, "ports", recipe.name, recipe.version, "#{recipe.name}-#{recipe.version}")
+    Dir.chdir(tarball_extract_path) do
+      system "cargo build --manifest-path=./c-api/Cargo.toml --release"
+    end
+    lib_header_path = File.join(tarball_extract_path, "c-api", "include")
+    lib_build_path = File.join(tarball_extract_path, "c-api", "target", "release")
+
+    HEADER_DIRS = [lib_header_path]
+    LIB_DIRS = [lib_build_path]
+
+    dir_config('commonmarkercomrak', HEADER_DIRS, LIB_DIRS)
+  end
+
+  recipe.activate
+
+  $LIBS << ' -lcomrak_ffi'
+  $LIBS << ' -lbcrypt' if windows
+end
+
+unless find_header("comrak_ffi.h")
+  abort("\nERROR: *** could not find comrak_ffi.h ***\n\n")
+end
+
+create_makefile("commonmarkercomrak/commonmarkercomrak")

data/ext/commonmarkercomrak/mkmf.log

@@ -0,0 +1,68 @@
+DYLD_FALLBACK_LIBRARY_PATH=.:/Users/gjtorikian/.rbenv/versions/3.1.1/lib pkg-config --exists /Users/gjtorikian/Development/commonmarker/ports/arm64-apple-darwin21.5.0/comrak/0.13.2/lib/pkgconfig/yaml-0.1.pc
+package configuration for /Users/gjtorikian/Development/commonmarker/ports/arm64-apple-darwin21.5.0/comrak/0.13.2/lib/pkgconfig/yaml-0.1.pc is not found
+have_library: checking for yaml_get_version() in -lyaml... -------------------- no
+
+DYLD_FALLBACK_LIBRARY_PATH=.:/Users/gjtorikian/.rbenv/versions/3.1.1/lib "clang -o conftest -I/Users/gjtorikian/.rbenv/versions/3.1.1/include/ruby-3.1.0/arm64-darwin21 -I/Users/gjtorikian/.rbenv/versions/3.1.1/include/ruby-3.1.0/ruby/backward -I/Users/gjtorikian/.rbenv/versions/3.1.1/include/ruby-3.1.0 -I. -I/Users/gjtorikian/.rbenv/versions/3.1.1/include  -D_XOPEN_SOURCE -D_DARWIN_C_SOURCE -D_DARWIN_UNLIMITED_SELECT -D_REENTRANT   -fdeclspec -O3 -fno-fast-math -ggdb3 -Wall -Wextra -Wdeprecated-declarations -Wdivision-by-zero -Wimplicit-function-declaration -Wimplicit-int -Wmisleading-indentation -Wpointer-arith -Wshorten-64-to-32 -Wwrite-strings -Wold-style-definition -Wmissing-noreturn -Wno-cast-function-type -Wno-constant-logical-operand -Wno-long-long -Wno-missing-field-initializers -Wno-overlength-strings -Wno-parentheses-equality -Wno-self-assign -Wno-tautological-compare -Wno-unused-parameter -Wno-unused-value -Wunused-variable -Wextra-tokens -Wundef  -fno-common -pipe conftest.c  -L. -L/Users/gjtorikian/.rbenv/versions/3.1.1/lib -L. -L/Users/gjtorikian/.rbenv/versions/3.1.1/lib  -fstack-protector-strong -L/usr/local/lib     -lruby.3.1   "
+checked program was:
+/* begin */
+1: #include "ruby.h"
+2: 
+3: int main(int argc, char **argv)
+4: {
+5:   return !!argv[argc];
+6: }
+/* end */
+
+DYLD_FALLBACK_LIBRARY_PATH=.:/Users/gjtorikian/.rbenv/versions/3.1.1/lib "clang -o conftest -I/Users/gjtorikian/.rbenv/versions/3.1.1/include/ruby-3.1.0/arm64-darwin21 -I/Users/gjtorikian/.rbenv/versions/3.1.1/include/ruby-3.1.0/ruby/backward -I/Users/gjtorikian/.rbenv/versions/3.1.1/include/ruby-3.1.0 -I. -I/Users/gjtorikian/.rbenv/versions/3.1.1/include  -D_XOPEN_SOURCE -D_DARWIN_C_SOURCE -D_DARWIN_UNLIMITED_SELECT -D_REENTRANT   -fdeclspec -O3 -fno-fast-math -ggdb3 -Wall -Wextra -Wdeprecated-declarations -Wdivision-by-zero -Wimplicit-function-declaration -Wimplicit-int -Wmisleading-indentation -Wpointer-arith -Wshorten-64-to-32 -Wwrite-strings -Wold-style-definition -Wmissing-noreturn -Wno-cast-function-type -Wno-constant-logical-operand -Wno-long-long -Wno-missing-field-initializers -Wno-overlength-strings -Wno-parentheses-equality -Wno-self-assign -Wno-tautological-compare -Wno-unused-parameter -Wno-unused-value -Wunused-variable -Wextra-tokens -Wundef  -fno-common -pipe conftest.c  -L. -L/Users/gjtorikian/.rbenv/versions/3.1.1/lib -L. -L/Users/gjtorikian/.rbenv/versions/3.1.1/lib  -fstack-protector-strong -L/usr/local/lib     -lruby.3.1 -lyaml   "
+conftest.c:3:10: fatal error: 'comrak.h' file not found
+#include <comrak.h>
+         ^~~~~~~~~~
+1 error generated.
+checked program was:
+/* begin */
+ 1: #include "ruby.h"
+ 2: 
+ 3: #include <comrak.h>
+ 4: 
+ 5: /*top*/
+ 6: extern int t(void);
+ 7: int main(int argc, char **argv)
+ 8: {
+ 9:   if (argc > 1000000) {
+10:     int (* volatile tp)(void)=(int (*)(void))&t;
+11:     printf("%d", (*tp)());
+12:   }
+13: 
+14:   return !!argv[argc];
+15: }
+16: int t(void) { void ((*volatile p)()); p = (void ((*)()))yaml_get_version; return !p; }
+/* end */
+
+DYLD_FALLBACK_LIBRARY_PATH=.:/Users/gjtorikian/.rbenv/versions/3.1.1/lib "clang -o conftest -I/Users/gjtorikian/.rbenv/versions/3.1.1/include/ruby-3.1.0/arm64-darwin21 -I/Users/gjtorikian/.rbenv/versions/3.1.1/include/ruby-3.1.0/ruby/backward -I/Users/gjtorikian/.rbenv/versions/3.1.1/include/ruby-3.1.0 -I. -I/Users/gjtorikian/.rbenv/versions/3.1.1/include  -D_XOPEN_SOURCE -D_DARWIN_C_SOURCE -D_DARWIN_UNLIMITED_SELECT -D_REENTRANT   -fdeclspec -O3 -fno-fast-math -ggdb3 -Wall -Wextra -Wdeprecated-declarations -Wdivision-by-zero -Wimplicit-function-declaration -Wimplicit-int -Wmisleading-indentation -Wpointer-arith -Wshorten-64-to-32 -Wwrite-strings -Wold-style-definition -Wmissing-noreturn -Wno-cast-function-type -Wno-constant-logical-operand -Wno-long-long -Wno-missing-field-initializers -Wno-overlength-strings -Wno-parentheses-equality -Wno-self-assign -Wno-tautological-compare -Wno-unused-parameter -Wno-unused-value -Wunused-variable -Wextra-tokens -Wundef  -fno-common -pipe conftest.c  -L. -L/Users/gjtorikian/.rbenv/versions/3.1.1/lib -L. -L/Users/gjtorikian/.rbenv/versions/3.1.1/lib  -fstack-protector-strong -L/usr/local/lib     -lruby.3.1 -lyaml   "
+conftest.c:3:10: fatal error: 'comrak.h' file not found
+#include <comrak.h>
+         ^~~~~~~~~~
+1 error generated.
+checked program was:
+/* begin */
+ 1: #include "ruby.h"
+ 2: 
+ 3: #include <comrak.h>
+ 4: 
+ 5: /*top*/
+ 6: extern int t(void);
+ 7: int main(int argc, char **argv)
+ 8: {
+ 9:   if (argc > 1000000) {
+10:     int (* volatile tp)(void)=(int (*)(void))&t;
+11:     printf("%d", (*tp)());
+12:   }
+13: 
+14:   return !!argv[argc];
+15: }
+16: extern void yaml_get_version();
+17: int t(void) { yaml_get_version(); return 0; }
+/* end */
+
+--------------------
+

data/lib/commonmarkercomrak/config.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module CommonmarkerComrak
+  module Config
+    # For details, see
+    # https://github.com/kivikakk/comrak/blob/162ef9354deb2c9b4a4e05be495aa372ba5bb696/src/main.rs#L201
+    OPTS = {
+      parse: {
+        smart: false,
+        default_info_string: "",
+      }.freeze,
+      render: {
+        hardbreaks: true,
+        github_pre_lang: true,
+        width: 80,
+        unsafe_: false,
+        escape: false,
+      }.freeze,
+      extension: {
+        strikethrough: true,
+        tagfilter: true,
+        table: true,
+        autolink: true,
+        tasklist: true,
+        superscript: false,
+        header_ids: "",
+        footnotes: false,
+        description_lists: false,
+        front_matter_delimiter: "",
+      },
+      format: [:html].freeze,
+    }.freeze
+
+    def self.merged_with_defaults(options)
+      CommonmarkerComrak::Config::OPTS.merge(process_options(options))
+    end
+
+    def self.process_options(options)
+      {
+        parse: process_parse_options(options[:parse]),
+        render: process_render_options(options[:render]),
+        extension: process_extension_options(options[:extension]),
+      }
+    end
+
+    BOOLS = [true, false]
+    ["parse", "render", "extension"].each do |type|
+      define_singleton_method :"process_#{type}_options" do |options|
+        CommonmarkerComrak::Config::OPTS[type.to_sym].each_with_object({}) do |(key, value), hash|
+          if options.nil? # option not provided, go for the default
+            hash[key] = value
+            next
+          end
+
+          # option explicitly not included, remove it
+          next if options[key].nil?
+
+          value_klass = value.class
+          if BOOLS.include?(value) && BOOLS.include?(options[key])
+            hash[key] = options[key]
+          elsif options[key].is_a?(value_klass)
+            hash[key] = options[key]
+          else
+            expected_type = BOOLS.include?(value) ? "Boolean" : value_klass.to_s
+            raise TypeError, "#{type}_options[:#{key}] must be a #{expected_type}; got #{options[key].class}"
+          end
+        end
+      end
+      # private :"process_#{type}_options"
+    end
+  end
+end

data/lib/commonmarkercomrak/renderer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "set"
+require "stringio"
+
+module CommonmarkerComrak
+  class Renderer
+  end
+end

data/lib/commonmarkercomrak/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CommonmarkerComrak
+  VERSION = "0.23.5"
+end

data/lib/commonmarkercomrak.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+begin
+  # load the precompiled extension file
+  ruby_version = /(\d+\.\d+)/.match(::RUBY_VERSION)
+  require_relative "commonmarkercomrak/#{ruby_version}/commonmarkercomrak"
+rescue LoadError
+  # fall back to the extension compiled upon installation.
+  require "commonmarkercomrak/commonmarkercomrak"
+end
+
+require "commonmarkercomrak/config"
+require "commonmarkercomrak/renderer"
+require "commonmarkercomrak/version"
+
+if ENV.fetch("DEBUG", false)
+  require "awesome_print"
+  require "debug"
+end
+
+module CommonmarkerComrak
+  # Public: Parses a CommonMark string into an HTML string.
+  #
+  # text - A {String} of text
+  # option - A {Hash} of render, parse, and extension options to transform the text.
+  #
+  # Returns a {String} of converted HTML.
+  def self.to_html(text, options: CommonmarkerComrak::Config::OPTS)
+    raise TypeError, "text must be a String; got a #{text.class}!" unless text.is_a?(String)
+    raise TypeError, "options must be a Hash; got a #{options.class}!" unless options.is_a?(Hash)
+
+    opts = Config.process_options(options)
+    commonmark_to_html(text.encode("UTF-8"), opts)
+  end
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: commonmarkercomrak
+version: !ruby/object:Gem::Version
+  version: 0.23.5
+platform: ruby
+authors:
+- Garen Torikian
+- Ashe Connor
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop-standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mini_portile2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description: A fast, safe, extensible parser for CommonMark. This wraps the comrak
+  Rust crate.
+email:
+executables: []
+extensions:
+- ext/commonmarkercomrak/extconf.rb
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- commonmarkercomrak.gemspec
+- ext/commonmarkercomrak/commonmarkercomrak.c
+- ext/commonmarkercomrak/commonmarkercomrak.h
+- ext/commonmarkercomrak/extconf.rb
+- ext/commonmarkercomrak/mkmf.log
+- lib/commonmarkercomrak.rb
+- lib/commonmarkercomrak/config.rb
+- lib/commonmarkercomrak/renderer.rb
+- lib/commonmarkercomrak/version.rb
+homepage: https://github.com/gjtorikian/commonmarkercomrak
+licenses:
+- MIT
+metadata:
+  funding_uri: https://github.com/sponsors/gjtorikian/
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: CommonMark parser and renderer. Written in Rust, wrapped in Ruby.
+test_files: []