commonmarker 1.0.0.pre6-x86_64-linux → 1.0.0.pre7-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a0114dc7e579a1819012a390ad7bc93303d53ac4d276e3b5c47543fd52c57a0
-  data.tar.gz: 3623268197b24a490b47189facc04a61826392ae566aaac8169e7596feab9780
+  metadata.gz: 6b835cb8791f4bc3c174e543b0a28e2e0a55dfd0f215dc1059f505581c41c9bd
+  data.tar.gz: 9102f14c6de4c6d5fa894321066ab57dc933bb564dd9ec7be6ca03e5cbcb9ee6
 SHA512:
-  metadata.gz: 8aeeae75f6283a0ae8d5dbce7680d46a9379732f25e420f463cf3f3431d58e9413a00d3bfd9e05a99427bc1398632e8b817267f3f43d47bc601ada2deea29efd
-  data.tar.gz: 7492d77e0e0271e63ce1519a990ec87aac228e9256375ce008f83922ec8d6b319d26e4725ccf8573e9d1ed0353cef40f3007cc1abe9029ea471a918e5fd879e7
+  metadata.gz: 964fe79f32f42ddff91184c4053b4e5c8236217e6ebeb68d74f3b2202f01b1f80df38c2909abab65fcb064282592966ff137aacbac3a9750c1f5f91b5d25e576
+  data.tar.gz: 6ed797f924b9ca48d758d394f5ab411c7f1db14ae0d651b54669f62b4ff37abe01b493b8872866f35cec6c714305b91f5d582a160682f0028912f79218139e00

data/Cargo.lock

@@ -167,11 +167,12 @@ dependencies = [
 
 [[package]]
 name = "comrak"
-version = "0.15.0"
+version = "0.16.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c11e55664fcff7f4d37cc2adf3a1996913692f037312f4ab0909047fdd2bf962"
+checksum = "784836d0812dade01579cc0cc9b1684847044e716fd7aa6bffbc172e42199500"
 dependencies = [
  "clap",
+ "emojis",
  "entities",
  "memchr",
  "once_cell",
@@ -179,6 +180,7 @@ dependencies = [
  "pest_derive",
  "regex",
  "shell-words",
+ "slug",
  "syntect",
  "typed-arena",
  "unicode_categories",
@@ -213,6 +215,12 @@ dependencies = [
  "typenum",
 ]
 
+[[package]]
+name = "deunicode"
+version = "0.4.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "850878694b7933ca4c9569d30a34b55031b9b139ee1fc7b94a527c4ef960d690"
+
 [[package]]
 name = "digest"
 version = "0.10.6"
@@ -243,6 +251,15 @@ dependencies = [
  "winapi",
 ]
 
+[[package]]
+name = "emojis"
+version = "0.5.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "44fe60b864b6544ad211d4053ced474a9b9d2c8d66b77f01d6c6bcfed10c6bf0"
+dependencies = [
+ "phf",
+]
+
 [[package]]
 name = "entities"
 version = "1.0.1"
@@ -568,6 +585,24 @@ dependencies = [
  "sha1",
 ]
 
+[[package]]
+name = "phf"
+version = "0.11.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "928c6535de93548188ef63bb7c4036bd415cd8f36ad25af44b9789b2ee72a48c"
+dependencies = [
+ "phf_shared",
+]
+
+[[package]]
+name = "phf_shared"
+version = "0.11.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e1fb5f6f826b772a8d4c0394209441e7d37cbbb967ae9c7e0e8134365c9ee676"
+dependencies = [
+ "siphasher",
+]
+
 [[package]]
 name = "pkg-config"
 version = "0.3.26"
@@ -785,6 +820,21 @@ version = "1.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "43b2853a4d09f215c24cc5489c992ce46052d359b5109343cbafbf26bc62f8a3"
 
+[[package]]
+name = "siphasher"
+version = "0.3.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7bd3e3206899af3f8b12af284fafc038cc1dc2b41d1b89dd17297221c5d225de"
+
+[[package]]
+name = "slug"
+version = "0.1.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b3bc762e6a4b6c6fcaade73e77f9ebc6991b676f88bb2358bddb56560f073373"
+dependencies = [
+ "deunicode",
+]
+
 [[package]]
 name = "strsim"
 version = "0.10.0"

data/README.md

@@ -7,7 +7,7 @@ Ruby wrapper for Rust's [comrak](https://github.com/kivikakk/comrak) crate.
 
 It passes all of the CommonMark test suite, 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).
+For more information on available extensions, see [the documentation below](#extension-options).
 
 ## Installation
 
@@ -27,7 +27,7 @@ Or install it yourself as:
 
 ### Converting to HTML
 
-Call `render_html` on a string to convert it to HTML:
+Call `to_html` on a string to convert it to HTML:
 
 ```ruby
 require 'commonmarker'
@@ -68,14 +68,14 @@ Note that there is a distinction in comrak for "parse" options and "render" opti
 | `hardbreaks`      | [Soft line breaks](http://spec.commonmark.org/0.27/#soft-line-breaks) translate into hard line breaks. | `true`  |
 | `github_pre_lang` | GitHub-style `<pre lang="xyz">` is used for fenced code blocks with info tags.                         | `true`  |
 | `width`           | The wrap column when outputting CommonMark.                                                            | `80`    |
-| `unsafe_`         | Allow rendering of raw HTML and potentially dangerous links.                                           | `false` |
+| `unsafe`          | Allow rendering of raw HTML and potentially dangerous links.                                           | `false` |
 | `escape`          | Escape raw HTML instead of clobbering it.                                                              | `false` |
 
 As well, there are several extensions which you can toggle in the same manner:
 
 ```ruby
 Commonmarker.to_html('"Hi *there*"', options: {
-    extensions: { footnotes: true, description_lists: true },
+    extension: { footnotes: true, description_lists: true },
     render: { hardbreaks: false}
 })
 ```
@@ -92,34 +92,38 @@ Commonmarker.to_html('"Hi *there*"', options: {
 | `superscript`            | Enables the superscript Comrak extension.                                                                           | `false` |
 | `header_ids`             | Enables the header IDs Comrak extension. from the GFM spec.                                                         | `""`    |
 | `footnotes`              | Enables the footnotes extension per `cmark-gfm`.                                                                    | `false` |
-| `description_lists`      | Enables the description lists extension..                                                                           | `false` |
+| `description_lists`      | Enables the description lists extension.                                                                            | `false` |
 | `front_matter_delimiter` | Enables the front matter extension.                                                                                 | `""`    |
+| `shortcodes`             | Enables the shortcodes extension.                                                                                   | `true`  |
 
 For more information on these options, see [the comrak documentation](https://github.com/kivikakk/comrak#usage).
 
 ### Plugins
 
 In addition to the possibilities provided by generic CommonMark rendering, Commonmarker also supports plugins as a means of
-providing further niceties. For example:
+providing further niceties.
 
-    code = <<~CODE
-        ```ruby
-        def hello
-        puts "hello"
-        end
+#### Syntax Highlighter Plugin
 
-        CODE
+````ruby
+code = <<~CODE
+  ```ruby
+  def hello
+  puts "hello"
+  end
+CODE
 
-    Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: "Inspired GitHub" } })
+puts Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: "InspiredGitHub" } })
 
-    # <pre style="background-color:#ffffff;" lang="ruby"><code>
-    # <span style="font-weight:bold;color:#a71d5d;">def </span><span style="font-weight:bold;color:#795da3;">hello
-    # </span><span style="color:#323232;"> </span><span style="color:#62a35c;">puts </span><span style="color:#183691;">&quot;hello&quot;
-    # </span><span style="font-weight:bold;color:#a71d5d;">end
-    # </span>
-    # </code></pre>
+# <pre style="background-color:#ffffff;" lang="ruby"><code>
+# <span style="font-weight:bold;color:#a71d5d;">def </span><span style="font-weight:bold;color:#795da3;">hello
+# </span><span style="color:#62a35c;">puts </span><span style="color:#183691;">&quot;hello&quot;
+# </span><span style="font-weight:bold;color:#a71d5d;">end
+# </span>
+# </code></pre>
+````
 
-You can disable plugins just the same as with options, by passing `nil`:
+To disable this plugin, pass `nil`:
 
 ```ruby
 Commonmarker.to_html(code, plugins: { syntax_highlighter: nil })
@@ -127,6 +131,18 @@ Commonmarker.to_html(code, plugins: { syntax_highlighter: nil })
 Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: nil } })
 ```
 
+##### Available themes
+
+Here's [a list of available themes](https://docs.rs/syntect/5.0.0/syntect/highlighting/struct.ThemeSet.html#implementations):
+
+- `"base16-ocean.dark"`
+- `"base16-eighties.dark"`
+- `"base16-mocha.dark"`
+- `"base16-ocean.light"`
+- `"InspiredGitHub"`
+- `"Solarized (dark)"`
+- `"Solarized (light)"`
+
 ## Output formats
 
 Commonmarker can currently only generate output in one format: HTML.

data/ext/commonmarker/Cargo.toml

@@ -5,7 +5,7 @@ edition = "2021"
 
 [dependencies]
 magnus =  "0.4"
-comrak = "0.15"
+comrak = { version = "0.16", features = ["shortcodes"] }
 
 [lib]
 name = "commonmarker"

data/ext/commonmarker/src/options.rs

@@ -29,7 +29,7 @@ fn iterate_parse_options(comrak_options: &mut ComrakOptions, options_hash: RHash
 const RENDER_HARDBREAKS: &str = "hardbreaks";
 const RENDER_GITHUB_PRE_LANG: &str = "github_pre_lang";
 const RENDER_WIDTH: &str = "width";
-const RENDER_UNSAFE: &str = "unsafe_";
+const RENDER_UNSAFE: &str = "unsafe";
 const RENDER_ESCAPE: &str = "escape";
 
 fn iterate_render_options(comrak_options: &mut ComrakOptions, options_hash: RHash) {
@@ -68,6 +68,7 @@ const EXTENSION_HEADER_IDS: &str = "header_ids";
 const EXTENSION_FOOTNOTES: &str = "footnotes";
 const EXTENSION_DESCRIPTION_LISTS: &str = "description_lists";
 const EXTENSION_FRONT_MATTER_DELIMITER: &str = "front_matter_delimiter";
+const EXTENSION_SHORTCODES: &str = "shortcodes";
 
 fn iterate_extension_options(comrak_options: &mut ComrakOptions, options_hash: RHash) {
     options_hash
@@ -103,6 +104,9 @@ fn iterate_extension_options(comrak_options: &mut ComrakOptions, options_hash: R
                 Ok(Cow::Borrowed(EXTENSION_FRONT_MATTER_DELIMITER)) => {
                     comrak_options.extension.front_matter_delimiter = try_convert_string(value);
                 }
+                Ok(Cow::Borrowed(EXTENSION_SHORTCODES)) => {
+                    comrak_options.extension.shortcodes = value.try_convert::<bool>()?;
+                }
                 _ => {}
             }
             Ok(ForEach::Continue)

data/lib/commonmarker/config.rb

@@ -13,7 +13,7 @@ module Commonmarker
         hardbreaks: true,
         github_pre_lang: true,
         width: 80,
-        unsafe_: false,
+        unsafe: false,
         escape: false,
       }.freeze,
       extension: {
@@ -27,6 +27,7 @@ module Commonmarker
         footnotes: false,
         description_lists: false,
         front_matter_delimiter: nil,
+        shortcodes: true,
       },
       format: [:html].freeze,
     }.freeze

data/lib/commonmarker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Commonmarker
-  VERSION = "1.0.0.pre6"
+  VERSION = "1.0.0.pre7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commonmarker
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre6
+  version: 1.0.0.pre7
 platform: x86_64-linux
 authors:
 - Garen Torikian
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-09 00:00:00.000000000 Z
+date: 2023-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys
@@ -78,7 +78,6 @@ files:
 - Cargo.lock
 - LICENSE.txt
 - README.md
-- commonmarker.gemspec
 - ext/commonmarker/Cargo.toml
 - ext/commonmarker/_util.rb
 - ext/commonmarker/extconf.rb
@@ -122,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.3.22
 requirements: []
-rubygems_version: 3.4.3
+rubygems_version: 3.4.4
 signing_key: 
 specification_version: 4
 summary: CommonMark parser and renderer. Written in Rust, wrapped in Ruby.

data/commonmarker.gemspec

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "commonmarker/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "commonmarker"
-  spec.version = Commonmarker::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.license = "MIT"
-  spec.homepage = "https://github.com/gjtorikian/commonmarker"
-
-  spec.required_ruby_version = "~> 3.1"
-  # https://github.com/rubygems/rubygems/pull/5852#issuecomment-1231118509
-  spec.required_rubygems_version = ">= 3.3.22"
-
-  spec.files = ["LICENSE.txt", "README.md", "commonmarker.gemspec", "Cargo.lock"]
-  spec.files += Dir.glob("lib/**/*.rb")
-  spec.files += Dir.glob("ext/**/*.{rs,toml,lock,rb}")
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-
-  spec.require_paths = ["lib"]
-  spec.extensions = ["ext/commonmarker/extconf.rb"]
-
-  spec.metadata = {
-    "allowed_push_host" => "https://rubygems.org",
-    "funding_uri" => "https://github.com/sponsors/gjtorikian/",
-    "source_code_uri" => "https://github.com/gjtorikian/commonmarker",
-    "rubygems_mfa_required" => "true",
-  }
-
-  spec.add_dependency("rb_sys", "~> 0.9")
-
-  spec.add_development_dependency("rake", "~> 13.0")
-  spec.add_development_dependency("rake-compiler", "~> 1.2")
-  spec.add_development_dependency("rake-compiler-dock", "~> 1.2")
-end