commonmarker 1.0.0-arm64-darwin

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eeeeadabfad4dced733c85bca4b18f2154fece4823633207cd9493b53b5c80c4
+  data.tar.gz: b3a4f8a1f7761f2da50e51d414f17745c130b5c2875de5b55c4f3deadf0e166a
+SHA512:
+  metadata.gz: 7c71926131405a94822a6c7bf0b4558db634289d3be9a377cb34ebab741446c2b40c78687f250b2c7c9ec2b72d009ecc9ef2610dedb73598f749224d8d618bdc
+  data.tar.gz: 8d67fe7a3cb13d5a033e4c8ab9f7bb1ae7ba4ec382e9cc519c2f2185bdfddb20296b5235651e74c73aa451c9e9f511bc28e590598b5910a50a2312657c050393

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,229 @@
+# Commonmarker
+
+> **Note**
+> This README refers to the behavior in the new 1.0.0.pre gem.
+
+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](#extension-options).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'commonmarker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install commonmarker
+
+## Usage
+
+### Converting to HTML
+
+Call `to_html` on a string to convert it to HTML:
+
+```ruby
+require 'commonmarker'
+Commonmarker.to_html('"Hi *there*"', options: {
+    parse: { smart: true }
+})
+# <p>“Hi <em>there</em>”</p>\n
+```
+
+The second argument is optional--[see below](#options) for more information.
+
+## Options and plugins
+
+### Options
+
+Commonmarker accepts the same parse, render, and extensions options that comrak does, as a hash dictionary with symbol keys:
+
+```ruby
+Commonmarker.to_html('"Hi *there*"', options:{
+  parse: { smart: true },
+  render: { hardbreaks: false}
+})
+```
+
+Note that there is a distinction in comrak for "parse" options and "render" options, which are represented in the tables below.
+
+### Parse options
+
+| Name                  | Description                                                                          | Default |
+| --------------------- | ------------------------------------------------------------------------------------ | ------- |
+| `smart`               | Punctuation (quotes, full-stops and hyphens) are converted into 'smart' punctuation. | `false` |
+| `default_info_string` | The default info string for fenced code blocks.                                      | `""`    |
+
+### Render options
+
+| Name              | Description                                                                                            | Default |
+| ----------------- | ------------------------------------------------------------------------------------------------------ | ------- |
+| `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` |
+| `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: {
+    extension: { footnotes: true, description_lists: true },
+    render: { hardbreaks: false}
+})
+```
+
+### Extension options
+
+| Name                     | Description                                                                                                         | Default |
+| ------------------------ | ------------------------------------------------------------------------------------------------------------------- | ------- |
+| `strikethrough`          | Enables the [strikethrough extension](https://github.github.com/gfm/#strikethrough-extension-) from the GFM spec.   | `true`  |
+| `tagfilter`              | Enables the [tagfilter extension](https://github.github.com/gfm/#disallowed-raw-html-extension-) from the GFM spec. | `true`  |
+| `table`                  | Enables the [table extension](https://github.github.com/gfm/#tables-extension-) from the GFM spec.                  | `true`  |
+| `autolink`               | Enables the [autolink extension](https://github.github.com/gfm/#autolinks-extension-) from the GFM spec.            | `true`  |
+| `tasklist`               | Enables the [task list extension](https://github.github.com/gfm/#task-list-items-extension-) from the GFM spec.     | `true`  |
+| `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` |
+| `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.
+
+#### Syntax Highlighter Plugin
+
+The library comes with [a set of pre-existing themes](https://docs.rs/syntect/5.0.0/syntect/highlighting/struct.ThemeSet.html#implementations) for highlighting code:
+
+- `"base16-ocean.dark"`
+- `"base16-eighties.dark"`
+- `"base16-mocha.dark"`
+- `"base16-ocean.light"`
+- `"InspiredGitHub"`
+- `"Solarized (dark)"`
+- `"Solarized (light)"`
+
+````ruby
+code = <<~CODE
+  ```ruby
+  def hello
+    puts "hello"
+  end
+  ```
+CODE
+
+# pass in a theme name from a pre-existing set
+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:#62a35c;">puts </span><span style="color:#183691;">&quot;hello&quot;
+# </span><span style="font-weight:bold;color:#a71d5d;">end
+# </span>
+# </code></pre>
+````
+
+By default, the plugin uses the `"base16-ocean.dark"` theme to syntax highlight code.
+
+To disable this plugin, set the value to `nil`:
+
+````ruby
+code = <<~CODE
+  ```ruby
+  def hello
+    puts "hello"
+  end
+  ```
+CODE
+
+Commonmarker.to_html(code, plugins: { syntax_highlighter: nil })
+
+# <pre lang="ruby"><code>def hello
+#   puts &quot;hello&quot;
+# end
+# </code></pre>
+````
+
+To output CSS classes instead of `style` attributes, set the `theme` key to `""`:
+
+````ruby
+code = <<~CODE
+  ```ruby
+  def hello
+    puts "hello"
+  end
+CODE
+
+Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: "" } })
+
+# <pre class="syntax-highlighting"><code><span class="source ruby"><span class="meta function ruby"><span class="keyword control def ruby">def</span></span><span class="meta function ruby"> # <span class="entity name function ruby">hello</span></span>
+#   <span class="support function builtin ruby">puts</span> <span class="string quoted double ruby"><span class="punctuation definition string begin ruby">&quot;</span>hello<span class="punctuation definition string end ruby">&quot;</span></span>
+# <span class="keyword control ruby">end</span>\n</span></code></pre>
+````
+
+To use a custom theme, you can provide a `path` to a directory containing `.tmtheme` files to load:
+
+```ruby
+Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: "Monokai", path: "./themes" } })
+```
+
+## Output formats
+
+Commonmarker can currently only generate output in one format: HTML.
+
+### HTML
+
+```ruby
+puts Commonmarker.to_html('*Hello* world!')
+
+# <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
+commonmarker with to_html
+                         1.000  i/100ms
+            kramdown     1.000  i/100ms
+Calculating -------------------------------------
+           redcarpet     22.317  (± 4.5%) i/s -    112.000  in   5.036374s
+commonmarker with to_html
+                          5.815  (± 0.0%) i/s -     30.000  in   5.168869s
+            kramdown      0.327  (± 0.0%) i/s -      2.000  in   6.121486s
+
+Comparison:
+           redcarpet:       22.3 i/s
+commonmarker with to_html:        5.8 i/s - 3.84x  (± 0.00) slower
+            kramdown:        0.3 i/s - 68.30x  (± 0.00) slower
+```

data/lib/commonmarker/config.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Commonmarker
+  module Config
+    # For details, see
+    # https://github.com/kivikakk/comrak/blob/162ef9354deb2c9b4a4e05be495aa372ba5bb696/src/main.rs#L201
+    OPTIONS = {
+      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: "",
+        shortcodes: true,
+      },
+      format: [:html].freeze,
+    }.freeze
+
+    PLUGINS = {
+      syntax_highlighter: {
+        theme: "base16-ocean.dark",
+        path: "",
+      },
+    }
+
+    class << self
+      include Commonmarker::Utils
+
+      def merged_with_defaults(options)
+        Commonmarker::Config::OPTIONS.merge(process_options(options))
+      end
+
+      def process_options(options)
+        {
+          parse: process_parse_options(options[:parse]),
+          render: process_render_options(options[:render]),
+          extension: process_extension_options(options[:extension]),
+        }
+      end
+
+      def process_plugins(plugins)
+        {
+          syntax_highlighter: process_syntax_highlighter_plugin(plugins&.fetch(:syntax_highlighter, nil)),
+        }
+      end
+    end
+
+    [:parse, :render, :extension].each do |type|
+      define_singleton_method :"process_#{type}_options" do |option|
+        Commonmarker::Config::OPTIONS[type].each_with_object({}) do |(key, value), hash|
+          if option.nil? # option not provided, go for the default
+            hash[key] = value
+            next
+          end
+
+          # option explicitly not included, remove it
+          next if option[key].nil?
+
+          hash[key] = fetch_kv(option, key, value, type)
+        end
+      end
+    end
+
+    [:syntax_highlighter].each do |type|
+      define_singleton_method :"process_#{type}_plugin" do |plugin|
+        return if plugin.nil? # plugin explicitly nil, remove it
+
+        Commonmarker::Config::PLUGINS[type].each_with_object({}) do |(key, value), hash|
+          if plugin.nil? # option not provided, go for the default
+            hash[key] = value
+            next
+          end
+
+          # option explicitly not included, remove it
+          next if plugin[key].nil?
+
+          hash[key] = fetch_kv(plugin, key, value, type)
+        end
+      end
+    end
+  end
+end

data/lib/commonmarker/constants.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Commonmarker
+  module Constants
+    BOOLS = [true, false].freeze
+  end
+end

data/lib/commonmarker/extension.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+begin
+  # native precompiled gems package shared libraries in <gem_dir>/lib/commonmarker/<ruby_version>
+  # load the precompiled extension file
+  ruby_version = /\d+\.\d+/.match(RUBY_VERSION)
+  require_relative "#{ruby_version}/commonmarker"
+rescue LoadError
+  # fall back to the extension compiled upon installation.
+  # use "require" instead of "require_relative" because non-native gems will place C extension files
+  # in Gem::BasicSpecification#extension_dir after compilation (during normal installation), which
+  # is in $LOAD_PATH but not necessarily relative to this file (see nokogiri#2300)
+  require "commonmarker/commonmarker"
+end

data/lib/commonmarker/renderer.rb

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

data/lib/commonmarker/utils.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "commonmarker/constants"
+
+module Commonmarker
+  module Utils
+    include Commonmarker::Constants
+
+    def fetch_kv(option, key, value, type)
+      value_klass = value.class
+
+      if Constants::BOOLS.include?(value) && BOOLS.include?(option[key])
+        option[key]
+      elsif option[key].is_a?(value_klass)
+        option[key]
+      else
+        expected_type = Constants::BOOLS.include?(value) ? "Boolean" : value_klass.to_s
+        raise TypeError, "#{type} option `:#{key}` must be #{expected_type}; got #{option[key].class}"
+      end
+    end
+  end
+end

data/lib/commonmarker/version.rb

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

data/lib/commonmarker.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "commonmarker/extension"
+
+require "commonmarker/utils"
+require "commonmarker/config"
+require "commonmarker/renderer"
+require "commonmarker/version"
+
+module Commonmarker
+  class << self
+    # Public: Parses a CommonMark string into an HTML string.
+    #
+    # text - A {String} of text
+    # options - A {Hash} of render, parse, and extension options to transform the text.
+    # plugins - A {Hash} of additional plugins.
+    #
+    # Returns a {String} of converted HTML.
+    def to_html(text, options: Commonmarker::Config::OPTIONS, plugins: Commonmarker::Config::PLUGINS)
+      raise TypeError, "text must be a String; got a #{text.class}!" unless text.is_a?(String)
+      raise TypeError, "text must be UTF-8 encoded; got #{text.encoding}!" unless text.encoding.name == "UTF-8"
+      raise TypeError, "options must be a Hash; got a #{options.class}!" unless options.is_a?(Hash)
+
+      opts = Config.process_options(options)
+      plugins = Config.process_plugins(plugins)
+
+      commonmark_to_html(text, options: opts, plugins: plugins)
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: commonmarker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: arm64-darwin
+authors:
+- Garen Torikian
+- Ashe Connor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: A fast, safe, extensible parser for CommonMark. This wraps the comrak
+  Rust crate.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/commonmarker.rb
+- lib/commonmarker/3.1/commonmarker.bundle
+- lib/commonmarker/3.2/commonmarker.bundle
+- lib/commonmarker/config.rb
+- lib/commonmarker/constants.rb
+- lib/commonmarker/extension.rb
+- lib/commonmarker/renderer.rb
+- lib/commonmarker/utils.rb
+- lib/commonmarker/version.rb
+homepage: https://github.com/gjtorikian/commonmarker
+licenses:
+- MIT
+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'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.3.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.22
+requirements: []
+rubygems_version: 3.4.4
+signing_key: 
+specification_version: 4
+summary: CommonMark parser and renderer. Written in Rust, wrapped in Ruby.
+test_files: []