commonmarker 0.20.1 → 0.20.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 237799ebff0e881aabc44799deac5c31a201307b
-  data.tar.gz: c2ebbe9b5bf5cc3ff8cb218c92a280eeb6aca70f
+SHA256:
+  metadata.gz: 0061cea8cfbad9898ad1fe7d9e9fd28b8add70a5e5bbe122b5e6ea86549f4f49
+  data.tar.gz: 1606082fb10db7dff360e5e96ec31ad71e98f2c4450ce94635350fc3695c4ff0
 SHA512:
-  metadata.gz: 2d5122a6869dc1b0e112a7ca8afcadfc53fda72c75f5bc0486e7046e59094f67f72f80955af1cc5fd6604ecea76361ee511c124b47f1c66f3f01496cf5a6b6ad
-  data.tar.gz: 39f7183d9f048c72729a916cefca93fecdc55e95054ff019fdeddc2ad94be5dbeb61c2c4ef7175373a0c2d520a72ad3743e415700bcbade0eb5dcdc37443ed16
+  metadata.gz: 8c3d9226cd6819f39fcdfb0e13dd7cd5610fc6a1531758ac578af447af798f8130c9c4f886f7f055a03a35b4dde4e903ca5a2ea35ad4466cb9606300f505ad5f
+  data.tar.gz: 5b4700f6d4024f0ea2a93a06afc46f90a65c694bc8f86f1148e1ac5a5f6ffdb50705c557035336183d8f14b27352a5d4e6037b160b34baf93c74aa5db1bc7144

data/README.md

@@ -176,6 +176,7 @@ Both `render_html` and `render_doc` take an optional third argument defining the
 The available extensions are:
 
 * `:table` - This provides support for tables.
+* `:tasklist` - This provides support for task list items.
 * `:strikethrough` - This provides support for strikethroughs.
 * `:autolink` - This provides support for automatically converting URLs to anchor tags.
 * `:tagfilter` - This escapes [several "unsafe" HTML tags](https://github.github.com/gfm/#disallowed-raw-html-extension-), causing them to not have any effect.

data/bin/commonmarker

@@ -1,60 +1,98 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Usage: commonmarker [--html-renderer] [--list-extensions] [--extension=EXTENSION] [FILE..]
-# Convert one or more CommonMark files to HTML and write to standard output.
-# If no FILE argument is provided, text will be read from STDIN.
-# With --html-renderer, use the HtmlRenderer renderer rather than the native C
-# renderer.
-# With --extension=EXTENSION, EXTENSION will be used for parsing, and HTML
-# output unless --html-renderer is specified.
-if ARGV.include?('--help') or ARGV.include?('-h')
-  File.read(__FILE__).split("\n").grep(/^# /).each do |line|
-    puts line[2..-1]
-  end
-  exit 0
-end
+require 'optparse'
+require 'ostruct'
 
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'commonmarker'
 
-if ARGV.include?('--version') or ARGV.include?('-v')
-  puts "commonmarker #{CommonMarker::VERSION}"
-  exit 0
-end
+root = File.expand_path('..', __dir__)
+$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
+
+  options.active_extensions = []
+  options.active_parse_options = [:DEFAULT]
+  options.active_render_options = [:DEFAULT]
+
+  option_parser = OptionParser.new do |opts|
+    opts.banner = 'Usage: commonmarker [--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 options: #{parse_options.keys.join(', ')}"
+      puts "Available render options: #{render_options.keys.join(', ')}"
+      puts
+      puts 'See the README for more information on these.'
+      exit
+    end
 
-root = File.expand_path('../../', __FILE__)
-$:.unshift File.expand_path('lib', root)
-
-extensions = CommonMarker.extensions
-active_extensions = []
-
-renderer = nil
-ARGV.delete_if do |arg|
-  if arg =~ /^--html-renderer$/
-    renderer = true
-    true
-  elsif arg =~ /^--list-extensions$/
-    puts extensions
-    exit 0
-  elsif arg =~ /^--extension=(.+)$/
-    if extensions.include?($1)
-      active_extensions << $1.intern
-    else
-      STDERR.puts "extension #$1 not found"
-      exit 1
+    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|
+        if parse_options.key?(value.to_sym)
+          options.active_parse_options << 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_options.key?(value.to_sym)
+          options.active_render_options << value.to_sym
+        else
+          abort("render-option '#{value}' not found")
+        end
+      end
+    end
+
+    opts.on('-v', '--version', 'Version information') do
+      puts "commonmarker #{CommonMarker::VERSION}"
+      exit
     end
-    true
-  else
-    false
   end
+
+  option_parser.parse!
+
+  options
 end
 
-doc = CommonMarker.render_doc(ARGF.read, :DEFAULT, active_extensions)
+options = parse_options
+
+doc = CommonMarker.render_doc(ARGF.read, options.active_parse_options, options.active_extensions)
 
-if renderer
-  renderer = CommonMarker::HtmlRenderer.new(extensions: active_extensions)
+if options.renderer
+  renderer = CommonMarker::HtmlRenderer.new(extensions: options.active_extensions)
   STDOUT.write(renderer.render(doc))
 else
-  STDOUT.write(doc.to_html(:DEFAULT, active_extensions))
+  STDOUT.write(doc.to_html(options.active_render_options, options.active_extensions))
 end

data/lib/commonmarker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CommonMarker
-  VERSION = '0.20.1'.freeze
+  VERSION = '0.20.2'.freeze
 end

data/test/fixtures/strong.md

@@ -0,0 +1 @@
+I am **strong**

data/test/fixtures/table.md

@@ -0,0 +1,10 @@
+One extension:
+
+| a   | b   |
+| --- | --- |
+| c   | d   |
+| **x** | |
+
+Another extension:
+
+~~hi~~

data/test/test_attributes.rb

@@ -4,7 +4,7 @@ require 'test_helper'
 
 class TestAttributes < Minitest::Test
   def setup
-    contents = File.read(File.join(FIXTURES_DIR, 'dingus.md'))
+    contents = fixtures_file('dingus.md')
     @doc = CommonMarker.render_doc(contents.strip)
   end
 

data/test/test_commands.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestCommands < Minitest::Test
+  def test_basic
+    out = make_bin('strong.md')
+    assert_equal out, '<p>I am <strong>strong</strong></p>'
+  end
+
+  def test_does_not_have_extensions
+    out = make_bin('table.md')
+    assert out.include?('| a')
+    refute out.include?('<p><del>hi</del>')
+    refute out.include?('<table> <tr> <th> a </th> <td> c </td>')
+  end
+
+  def test_understands_extensions
+    out = make_bin('table.md', '--extension=table')
+    refute out.include?('| a')
+    refute out.include?('<p><del>hi</del>')
+    %w[<table> <tr> <th> a </th> <td> c </td>].each { |html| assert out.include?(html) }
+  end
+
+  def test_understands_multiple_extensions
+    out = make_bin('table.md', '--extension=table,strikethrough')
+    refute out.include?('| a')
+    assert out.include?('<p><del>hi</del>')
+    %w[<table> <tr> <th> a </th> <td> c </td>].each { |html| assert out.include?(html) }
+  end
+end

data/test/test_encoding.rb

@@ -6,7 +6,7 @@ require 'test_helper'
 class TestEncoding < Minitest::Test
   # see http://git.io/vq4FR
   def test_encoding
-    contents = File.read(File.join(FIXTURES_DIR, 'curly.md'), encoding: 'utf-8')
+    contents = fixtures_file('curly.md')
     doc = CommonMarker.render_doc(contents, :SMART)
     render = doc.to_html
     assert_equal render.rstrip, '<p>This curly quote “makes commonmarker throw an exception”.</p>'

data/test/test_extensions.rb

@@ -4,18 +4,7 @@ require 'test_helper'
 
 class TestExtensions < Minitest::Test
   def setup
-    @markdown = <<-MD
-One extension:
-
-| a   | b   |
-| --- | --- |
-| c   | d   |
-| **x** | |
-
-Another extension:
-
-~~hi~~
-    MD
+    @markdown = fixtures_file('table.md')
   end
 
   def test_uses_specified_extensions

data/test/test_helper.rb

@@ -10,6 +10,14 @@ include CommonMarker
 
 FIXTURES_DIR = File.join(File.dirname(__FILE__), 'fixtures')
 
+def fixtures_file(file)
+  File.read(File.join(FIXTURES_DIR, file), encoding: 'utf-8')
+end
+
+def make_bin(file, args = '')
+  `ruby bin/commonmarker #{File.join(FIXTURES_DIR, file)} #{args}`.chomp
+end
+
 def open_spec_file(filename)
   line_number = 0
   start_line = 0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commonmarker
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.20.2
 platform: ruby
 authors:
 - Garen Torikian
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-29 00:00:00.000000000 Z
+date: 2019-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-enum
@@ -246,8 +246,11 @@ files:
 - test/benchmark.rb
 - test/fixtures/curly.md
 - test/fixtures/dingus.md
+- test/fixtures/strong.md
+- test/fixtures/table.md
 - test/test_attributes.rb
 - test/test_basics.rb
+- test/test_commands.rb
 - test/test_commonmark.rb
 - test/test_doc.rb
 - test/test_encoding.rb
@@ -287,8 +290,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: CommonMark parser and renderer. Written in C, wrapped in Ruby.
@@ -296,8 +298,11 @@ test_files:
 - test/benchmark.rb
 - test/fixtures/curly.md
 - test/fixtures/dingus.md
+- test/fixtures/strong.md
+- test/fixtures/table.md
 - test/test_attributes.rb
 - test/test_basics.rb
+- test/test_commands.rb
 - test/test_commonmark.rb
 - test/test_doc.rb
 - test/test_encoding.rb