markly 0.7.0 → 0.8.0

data/lib/markly.rb

@@ -1,7 +1,13 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# The compiled library.
+# Released under the MIT License.
+# Copyright, 2014, by John MacFarlane.
+# Copyright, 2015-2019, by Garen Torikian.
+# Copyright, 2015, by Nick Wellnhofer.
+# Copyright, 2016-2017, by Yuki Izumi.
+# Copyright, 2020-2023, by Samuel Williams.
+
 require 'markly/markly'
 
 require_relative 'markly/flags'
@@ -11,33 +17,33 @@ require_relative 'markly/renderer/html'
 require_relative 'markly/version'
 
 module Markly
-  # Public: Parses a Markdown string into a `document` node.
-  #
-  # string - {String} to be parsed
-  # option - A {Symbol} or {Array of Symbol}s indicating the parse options
-  # extensions - An {Array of Symbol}s indicating the extensions to use
-  #
-  # Returns the `parser` node.
-  def self.parse(text, flags: DEFAULT, extensions: nil)
-    parser = Parser.new(flags)
-    
-    extensions&.each do |extension|
-      parser.enable(extension)
-    end
-    
-    return parser.parse(text.encode(Encoding::UTF_8))
-  end
-  
-  # Public:  Parses a Markdown string into an HTML string.
-  #
-  # text - A {String} of text
-  # option - Either a {Symbol} or {Array of Symbol}s indicating the render options
-  # extensions - An {Array of Symbol}s indicating the extensions to use
-  #
-  # Returns a {String} of converted HTML.
-  def self.render_html(text, flags: DEFAULT, parse_flags: flags, render_flags: flags, extensions: [])
-    root = self.parse(text, flags: parse_flags, extensions: extensions)
-    
-    return root.to_html(flags: render_flags, extensions: extensions)
-  end
+	# Public: Parses a Markdown string into a `document` node.
+	#
+	# string - {String} to be parsed
+	# option - A {Symbol} or {Array of Symbol}s indicating the parse options
+	# extensions - An {Array of Symbol}s indicating the extensions to use
+	#
+	# Returns the `parser` node.
+	def self.parse(text, flags: DEFAULT, extensions: nil)
+		parser = Parser.new(flags)
+		
+		extensions&.each do |extension|
+			parser.enable(extension)
+		end
+		
+		return parser.parse(text.encode(Encoding::UTF_8))
+	end
+	
+	# Public:  Parses a Markdown string into an HTML string.
+	#
+	# text - A {String} of text
+	# option - Either a {Symbol} or {Array of Symbol}s indicating the render options
+	# extensions - An {Array of Symbol}s indicating the extensions to use
+	#
+	# Returns a {String} of converted HTML.
+	def self.render_html(text, flags: DEFAULT, parse_flags: flags, render_flags: flags, extensions: [])
+		root = self.parse(text, flags: parse_flags, extensions: extensions)
+		
+		return root.to_html(flags: render_flags, extensions: extensions)
+	end
 end

data/license.md

@@ -0,0 +1,39 @@
+# MIT License
+
+Copyright, 2014, by John MacFarlane.  
+Copyright, 2015-2020, by Garen Torikian.  
+Copyright, 2015, by Nick Wellnhofer.  
+Copyright, 2015-2017, by Andrew Anderson.  
+Copyright, 2016-2017, by Yuki Izumi.  
+Copyright, 2017, by Mu-An Chiou.  
+Copyright, 2017-2018, by Goro Fuji.  
+Copyright, 2017, by Ben Woosley.  
+Copyright, 2017, by Roberto Hidalgo.  
+Copyright, 2017-2020, by Ashe Connor.  
+Copyright, 2018, by Jerry van Leeuwen.  
+Copyright, 2018, by Vitaliy Klachkov.  
+Copyright, 2018, by Michael Camilleri.  
+Copyright, 2018, by Akira Matsuda.  
+Copyright, 2018, by Danny Iachini.  
+Copyright, 2019-2020, by Tomoya Chiba.  
+Copyright, 2019, by Brett Walker.  
+Copyright, 2020, by Olle Jonsson.  
+Copyright, 2020-2023, by Samuel Williams.  
+
+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,36 @@
+# Markly
+
+A parser and abstract syntax tree for Markdown documents (CommonMark compatible) in Ruby. Originally forked from
+[CommonMarker](https://github.com/gjtorikian/commonmarker). 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.
+
+[![Development
+Status](https://github.com/ioquatix/markly/workflows/Test/badge.svg)](https://github.com/ioquatix/markly/actions?workflow=Test)
+
+## Motivation
+
+This code base was originally forked from [Commonmarker](https://github.com/gjtorikian/commonmarker) before they
+switched from `cmark-gfm` (C) to `comrak` (Rust). The original implementation provided access to the abstract syntax
+tree (AST), which is useful for building tools on top of Markdown. The Rust implementation does not provide this
+functionality, and so this fork was created to continue to provide these (and more) features.
+
+## Usage
+
+Please see the [project documentation](https://ioquatix.github.io/markly/) for more details.
+
+  - [Getting Started](https://ioquatix.github.io/markly/guides/getting-started/index) - This guide explains now to
+    install and use Markly.
+
+  - [Abstract Syntax Tree](https://ioquatix.github.io/markly/guides/abstract-syntax-tree/index) - This guide explains
+    how to use Markly's abstract syntax tree (AST) to parse and manipulate Markdown documents.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.

metadata

@@ -1,16 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: markly
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Garen Torikian
-- Ashe Connor
+- Yuki Izumi
 - Samuel Williams
+- John MacFarlane
+- Ashe Connor
+- Nick Wellnhofer
+- Brett Walker
+- Andrew Anderson
+- Ben Woosley
+- Goro Fuji
+- Tomoya Chiba
+- Akira Matsuda
+- Danny Iachini
+- Jerry van Leeuwen
+- Michael Camilleri
+- Mu-An Chiou
+- Olle Jonsson
+- Roberto Hidalgo
+- Vitaliy Klachkov
 autorequire:
 bindir: bin
-cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2023-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bake
@@ -27,21 +72,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !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: rake
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -55,28 +86,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: sus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 description:
 email:
-executables:
-- markly
+executables: []
 extensions:
 - ext/markly/extconf.rb
 extra_rdoc_files: []
 files:
-- bin/markly
+- conduct.md
 - ext/markly/arena.c
 - ext/markly/autolink.c
 - ext/markly/autolink.h
@@ -150,17 +180,19 @@ files:
 - ext/markly/xml.c
 - lib/markly.rb
 - lib/markly/flags.rb
-- lib/markly/markly.bundle
 - lib/markly/node.rb
 - lib/markly/node/inspect.rb
 - lib/markly/renderer/generic.rb
 - lib/markly/renderer/html.rb
 - lib/markly/version.rb
+- license.md
+- readme.md
 homepage: https://github.com/ioquatix/markly
 licenses:
 - MIT
 metadata:
   funding_uri: https://github.com/sponsors/ioquatix/
+  documentation_uri: https://ioquatix.github.io/markly/
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -176,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: CommonMark parser and renderer. Written in C, wrapped in Ruby.

data/bin/markly

@@ -1,94 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'optparse'
-require 'ostruct'
-
-require_relative '../lib/markly'
-
-def parse_options
-  options = OpenStruct.new
-  extensions = Markly.extensions
-  parse_flags = Markly::PARSE_FLAGS
-  render_flags = Markly::RENDER_FLAGS
-
-  options.active_extensions = []
-  options.active_parse_flags = Markly::DEFAULT
-  options.active_render_flags = Markly::DEFAULT
-
-  option_parser = OptionParser.new do |opts|
-    opts.banner = 'Usage: markly [--html-renderer] [--extension=EXTENSION]'
-    opts.separator '                    [--parse-option=OPTION]'
-    opts.separator '                    [--render-option=OPTION]'
-    opts.separator '                    [FILE..]'
-    opts.separator ''
-    opts.separator 'Convert one or more CommonMark files to HTML and write to standard output.'
-    opts.separator 'If no FILE argument is provided, text will be read from STDIN.'
-    opts.separator ''
-
-    opts.on('--extension=EXTENSION', Array, 'Use EXTENSION for parsing and HTML output (unless --html-renderer is specified)') do |values|
-      values.each do |value|
-        if extensions.include?(value)
-          options.active_extensions << value.to_sym
-        else
-          abort("extension '#{value}' not found")
-        end
-      end
-    end
-
-    opts.on('-h', '--help', 'Prints this help') do
-      puts opts
-      puts
-      puts "Available extentions: #{extensions.join(', ')}"
-      puts "Available parse flags: #{parser_flags.keys.join(', ')}"
-      puts "Available render flags: #{render_flags.keys.join(', ')}"
-      puts
-      puts 'See the README for more information on these.'
-      exit
-    end
-
-    opts.on('--html-renderer', 'Use the HtmlRenderer renderer rather than the native C renderer') do
-      options.renderer = true
-    end
-
-    opts.on('--parse-option=OPTION', Array, 'OPTION passed during parsing') do |values|
-      values.each do |value|active_parser_flags
-        if parser_flags.key?(value.to_sym)
-          options.active_parser_flags << value.to_sym
-        else
-          abort("parse-option '#{value}' not found")
-        end
-      end
-    end
-
-    opts.on('--render-option=OPTION', Array, 'OPTION passed during rendering') do |values|
-      values.each do |value|
-        if render_flags.key?(value.to_sym)
-          options.active_render_flags << value.to_sym
-        else
-          abort("render-option '#{value}' not found")
-        end
-      end
-    end
-
-    opts.on('-v', '--version', 'Version information') do
-      puts "markly #{Markly::VERSION}"
-      exit
-    end
-  end
-
-  option_parser.parse!
-
-  options
-end
-
-options = parse_options
-
-doc = Markly.parse(ARGF.read, flags: options.active_parse_flags, extensions: options.active_extensions)
-
-if options.renderer
-  renderer = Markly::HtmlRenderer.new(extensions: options.active_extensions)
-  STDOUT.write(renderer.render(doc))
-else
-  STDOUT.write(doc.to_html(flags: options.active_render_flags, extensions: options.active_extensions))
-end