motion-markdown-it 4.4.0 → 8.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb7bc35a96283f575397326f35cc15789b4700fe
-  data.tar.gz: feacd41709859ddb7b8fd30f288af2a53c80c562
+  metadata.gz: e01060bf95d44944bd2081ba624c238497dfc66b
+  data.tar.gz: 8fdb0bc2d0b0d45dd2912af9541a34dba71776a2
 SHA512:
-  metadata.gz: d64baed7b2ed7ecadc4b3a31b9d723502ab564e08871401b0d9b2d7dfeb017e12c09656692639f6d1b5dc911a0cc4605c8d832181e2c5b05c43d0e725c6edec0
-  data.tar.gz: 6dc2d585c57113b580d398c9370db04a22c7cb8c8470af53857c8a1b5df67601368c4aa557cf4b791201a3cef7e1a7d063190857d059f24508a546d6b77ac874
+  metadata.gz: e8e57f8c16c37aa08854257b56caf0a40428d8bce50c5b2ce7ad1d59ff724029fc97c59b152bd63e196b200da7ad7ef2a56132622c6e54279830b233e1baf398
+  data.tar.gz: 0adebed4df5b22d1f51c1204bea082074631d190705cc53056ddb7a0e2079aa8d3900fa71d8dd876852c113e45d07b3fcffb1b7325c35fe4a2690ca63f9d5bfc

data/README.md

@@ -3,17 +3,17 @@
 [![Gem Version](https://badge.fury.io/rb/motion-markdown-it.svg)](http://badge.fury.io/rb/motion-markdown-it)
 [![Build Status](https://travis-ci.org/digitalmoksha/motion-markdown-it.svg?branch=master)](https://travis-ci.org/digitalmoksha/motion-markdown-it)
 
-https://travis-ci.org/digitalmoksha/motion-markdown-it.svg?branch=master
 Ruby/RubyMotion version of Markdown-it (CommonMark compliant and extendable)
 
-This gem is a port of the [markdown-it Javascript package](https://github.com/markdown-it/markdown-it) by Vitaly Puzrin and Alex Kocharin. Currently synced with markdown-it 4.4.0
+This gem is a port of the [markdown-it Javascript package](https://github.com/markdown-it/markdown-it) by Vitaly Puzrin and Alex Kocharin. Currently synced with markdown-it 8.4.1
+
+---
 
 __[Javascript Live demo](https://markdown-it.github.io)__
 
 Follows the __[CommonMark spec](http://spec.commonmark.org/)__ + adds syntax extensions & sugar (URL autolinking, typographer).
 - Configurable syntax. You can add new rules and even replace existing ones.
 - [Safe](https://github.com/markdown-it/markdown-it/tree/master/docs/security.md) by default.
-- Community-written plugins
 - Community-written plugins
   * [Ruby/RubyMotion](https://github.com/digitalmoksha/motion-markdown-it-plugins)
   * [original javascript plugins](https://www.npmjs.org/browse/keyword/markdown-it-plugin) and [other packages](https://www.npmjs.org/browse/keyword/markdown-it) on npm.
@@ -24,7 +24,31 @@ The benefit of this project, for me at least, is to have a standardized CommonMa
 
 ## Performance
 
-Performance is still an issue.  While it performs reasonably well with small to medium files, it degrades for large files.  Work in progress...
+Performance is slower than, say, `kramdown`, but for most uses, is pretty fast.  Here are some non-scientific benchmarks.  Note that `kramdown` and `redcarpet` are not CommonMark compliant.
+
+```
+Running tests on 2018-04-04 under ruby 2.3.1p112 (2016-04-26 revision 54768) [x86_64-darwin16]
+
+==> Test using file mdsyntax.text and 500 runs
+Rehearsal -------------------------------------------------------------
+motion-markdown-it 8.4.1   17.940000   0.710000  18.650000 ( 18.721629)
+kramdown 1.16.2            14.720000   0.180000  14.900000 ( 15.015840)
+commonmarker 0.17.9         0.220000   0.000000   0.220000 (  0.222098)
+redcarpet 3.4.0             0.140000   0.010000   0.150000 (  0.145821)
+--------------------------------------------------- total: 33.920000sec
+
+                                user     system      total        real
+motion-markdown-it 8.4.1   18.290000   0.720000  19.010000 ( 19.113943)
+kramdown 1.16.2            13.320000   0.110000  13.430000 ( 13.459096)
+commonmarker 0.17.9         0.190000   0.000000   0.190000 (  0.187104)
+redcarpet 3.4.0             0.120000   0.000000   0.120000 (  0.123931)
+
+Real time as a factor of motion-markdown-it
+motion-markdown-it 8.4.1    1.0
+kramdown 1.16.2             0.7042
+commonmarker 0.17.9         0.0098
+redcarpet 3.4.0             0.0065
+````
 
 ## Table of content
 
@@ -114,7 +138,7 @@ parser = MarkdownIt::Parser.new({
   quotes: '“”‘’',
 
   # Highlighter function. Should return escaped HTML,
-  # or nil if the source string is not changed and should be escaped externaly.
+  # or nil if the source string is not changed and should be escaped externally.
   highlight: lambda {|str, lang| return nil}
 })
 ```
@@ -148,7 +172,7 @@ var md = require('markdown-it')()
 Apply syntax highlighting to fenced code blocks with the `highlight` option:
 
 ```js
-var hljs = require('highlight.js') // https://highlightjs.org/
+var hljs = require('highlight.js'); // https://highlightjs.org/
 
 // Actual default values
 var md = require('markdown-it')({
@@ -159,15 +183,41 @@ var md = require('markdown-it')({
       } catch (__) {}
     }
 
-    try {
-      return hljs.highlightAuto(str).value;
-    } catch (__) {}
-
     return ''; // use external default escaping
   }
 });
 ```
 
+Or with full wrapper override (if you need assign class to `<pre>`):
+
+```js
+var hljs = require('highlight.js'); // https://highlightjs.org/
+
+// Actual default values
+var md = require('markdown-it')({
+  highlight: function (str, lang) {
+    if (lang && hljs.getLanguage(lang)) {
+      try {
+        return '<pre class="hljs"><code>' +
+               hljs.highlight(lang, str, true).value +
+               '</code></pre>';
+      } catch (__) {}
+    }
+
+    return '<pre class="hljs"><code>' + md.utils.escapeHtml(str) + '</code></pre>';
+  }
+});
+```
+
+### Linkify
+
+`linkify: true` uses [linkify-it](https://github.com/markdown-it/linkify-it). To
+configure linkify-it, access the linkify instance through `md.linkify`:
+
+```js
+md.linkify.tlds('.py', false);  // disables .py as top level domain
+```
+
 
 ## API
 
@@ -181,8 +231,8 @@ If you are going to write plugins - take a look at
 
 Embedded (enabled by default):
 
-- [Tables](https://help.github.com/articles/github-flavored-markdown/#tables) (GFM)
-- [Strikethrough](https://help.github.com/articles/github-flavored-markdown/#strikethrough) (GFM)
+- [Tables](https://help.github.com/articles/organizing-information-with-tables/) (GFM)
+- [Strikethrough](https://help.github.com/articles/basic-writing-and-formatting-syntax/#styling-text) (GFM)
 
 Via plugins:
 
@@ -211,7 +261,7 @@ var md = require('markdown-it')()
             .enable('image');
 
 // Enable everything
-md = require('markdown-it')('full', {
+md = require('markdown-it')({
   html: true,
   linkify: true,
   typographer: true,
@@ -219,12 +269,14 @@ md = require('markdown-it')('full', {
 ```
 
 
-## Benchmark (for Javascript version)
+## Benchmark
 
 Here is the result of readme parse at MB Pro Retina 2013 (2.4 GHz):
 
 ```bash
-$ benchmark/benchmark.js readme
+make benchmark-deps
+benchmark/benchmark.js readme
+
 Selected samples: (1 of 28)
  > README
 
@@ -232,7 +284,7 @@ Sample: README.md (7774 bytes)
  > commonmark-reference x 1,222 ops/sec ±0.96% (97 runs sampled)
  > current x 743 ops/sec ±0.84% (97 runs sampled)
  > current-commonmark x 1,568 ops/sec ±0.84% (98 runs sampled)
- > marked-0.3.2 x 1,587 ops/sec ±4.31% (93 runs sampled)
+ > marked x 1,587 ops/sec ±4.31% (93 runs sampled)
 ```
 
 __Note.__ CommonMark version runs with [simplified link normalizers](https://github.com/markdown-it/markdown-it/blob/master/benchmark/implementations/current-commonmark/index.js)
@@ -242,6 +294,7 @@ As you can see, `markdown-it` doesn't pay with speed for it's flexibility.
 Slowdown of "full" version caused by additional features not available in
 other implementations.
 
+
 -->
 
 ## References / Thanks

data/lib/motion-markdown-it.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 if defined?(Motion::Project::Config)
-  
+
   lib_dir_path = File.dirname(File.expand_path(__FILE__))
   Motion::Project::App.setup do |app|
     app.files.unshift(Dir.glob(File.join(lib_dir_path, "motion-markdown-it/**/*.rb")))
@@ -12,7 +12,7 @@ if defined?(Motion::Project::Config)
   require 'uc.micro-rb'
 
 else
-  
+
   require 'mdurl-rb'
   require 'uc.micro-rb'
   require 'linkify-it-rb'
@@ -23,13 +23,13 @@ else
   require 'motion-markdown-it/common/entities'
   require 'motion-markdown-it/common/utils'
   require 'motion-markdown-it/common/html_blocks'
-  require 'motion-markdown-it/common/url_schemas'
   require 'motion-markdown-it/common/html_re'
   require 'motion-markdown-it/common/string'
   require 'motion-markdown-it/common/simpleidn'
   require 'motion-markdown-it/helpers/parse_link_destination'
   require 'motion-markdown-it/helpers/parse_link_label'
   require 'motion-markdown-it/helpers/parse_link_title'
+  require 'motion-markdown-it/helpers/helper_wrapper'
   require 'motion-markdown-it/parser_inline'
   require 'motion-markdown-it/parser_block'
   require 'motion-markdown-it/parser_core'
@@ -55,6 +55,7 @@ else
   require 'motion-markdown-it/rules_block/table'
   require 'motion-markdown-it/rules_inline/autolink'
   require 'motion-markdown-it/rules_inline/backticks'
+  require 'motion-markdown-it/rules_inline/balance_pairs'
   require 'motion-markdown-it/rules_inline/emphasis'
   require 'motion-markdown-it/rules_inline/entity'
   require 'motion-markdown-it/rules_inline/escape'
@@ -64,10 +65,11 @@ else
   require 'motion-markdown-it/rules_inline/newline'
   require 'motion-markdown-it/rules_inline/state_inline'
   require 'motion-markdown-it/rules_inline/strikethrough'
+  require 'motion-markdown-it/rules_inline/text_collapse'
   require 'motion-markdown-it/rules_inline/text'
-  
+
   require 'motion-markdown-it/ruler'
   require 'motion-markdown-it/token'
   require 'motion-markdown-it/index'
-  
+
 end

data/lib/motion-markdown-it/common/html_blocks.rb

@@ -29,10 +29,16 @@ module MarkdownIt
     'frame',
     'frameset',
     'h1',
+    'h2',
+    'h3',
+    'h4',
+    'h5',
+    'h6',
     'head',
     'header',
     'hr',
     'html',
+    'iframe',
     'legend',
     'li',
     'link',
@@ -47,10 +53,8 @@ module MarkdownIt
     'option',
     'p',
     'param',
-    'pre',
     'section',
     'source',
-    'title',
     'summary',
     'table',
     'tbody',

data/lib/motion-markdown-it/common/utils.rb

@@ -51,6 +51,11 @@ module MarkdownIt
         c.chr(Encoding::UTF_8)
       end
 
+      #------------------------------------------------------------------------------
+      def fromCharCode(c)
+        c.chr
+      end
+
 
       UNESCAPE_MD_RE  = /\\([\!\"\#\$\%\&\'\(\)\*\+\,\-.\/:;<=>?@\[\\\]^_`{|}~])/
 
@@ -63,7 +68,7 @@ module MarkdownIt
       def replaceEntityPattern(match, name)
         code = 0
 
-        return HTMLEntities::MAPPINGS[name].chr(Encoding::UTF_8) if HTMLEntities::MAPPINGS[name]
+        return fromCodePoint(HTMLEntities::MAPPINGS[name]) if HTMLEntities::MAPPINGS[name]
 
         if (name.charCodeAt(0) == 0x23 && DIGITAL_ENTITY_TEST_RE =~ name) # '#'
           code = name[1].downcase == 'x' ? name.slice_to_end(2).to_i(16) : name.slice_to_end(1).to_i
@@ -116,6 +121,16 @@ module MarkdownIt
         str.gsub(REGEXP_ESCAPE_RE) {|s| '\\' + s}
       end
 
+      #------------------------------------------------------------------------------
+      def isSpace(code)
+        case code
+        when 0x09,
+             0x20
+          return true
+        end
+
+        return false
+      end
 
       # Zs (unicode class) || [\t\f\v\r\n]
       #------------------------------------------------------------------------------
@@ -142,13 +157,13 @@ module MarkdownIt
 
       # Currently without astral characters support.
       #------------------------------------------------------------------------------
-      def isPunctChar(char)
-        return UNICODE_PUNCT_RE =~ char
+      def isPunctChar(ch)
+        return UNICODE_PUNCT_RE =~ ch
       end
 
 
       # Markdown ASCII punctuation characters.
-      # 
+      #
       # !, ", #, $, %, &, ', (, ), *, +, ,, -, ., /, :, ;, <, =, >, ?, @, [, \, ], ^, _, `, {, |, }, or ~
       # http://spec.commonmark.org/0.15/#ascii-punctuation-character
       #

data/lib/motion-markdown-it/helpers/helper_wrapper.rb

@@ -0,0 +1,9 @@
+module MarkdownIt
+  module Helpers
+    class HelperWrapper
+      include ParseLinkDestination
+      include ParseLinkLabel
+      include ParseLinkTitle
+    end
+  end
+end

data/lib/motion-markdown-it/helpers/parse_link_destination.rb

@@ -3,18 +3,19 @@
 module MarkdownIt
   module Helpers
     module ParseLinkDestination
-      
+      include Common::Utils
+
       #------------------------------------------------------------------------------
       def parseLinkDestination(str, pos, max)
         lines = 0
         start = pos
         result = {ok: false, pos: 0, lines: 0, str: ''}
 
-        if (str.charCodeAt(pos) == 0x3C ) # < 
+        if (str.charCodeAt(pos) == 0x3C ) # <
           pos += 1
           while (pos < max)
             code = str.charCodeAt(pos)
-            return result if (code == 0x0A ) # \n
+            return result if (code == 0x0A || isSpace(code)) # \n
             if (code == 0x3E) #  >
               result[:pos] = pos + 1
               result[:str] = unescapeAll(str.slice((start + 1)...pos))
@@ -36,7 +37,7 @@ module MarkdownIt
         # this should be ... } else { ... branch
 
         level = 0
-        while (pos < max) 
+        while (pos < max)
           code = str.charCodeAt(pos)
 
           break if (code == 0x20)
@@ -51,18 +52,18 @@ module MarkdownIt
 
           if (code == 0x28) # (
             level += 1
-            break if (level > 1)
           end
 
           if (code == 0x29) # )
+            break if (level == 0)
             level -= 1
-            break if (level < 0)
           end
 
           pos += 1
         end
 
-        return result if (start == pos)
+        return result if start == pos
+        return result if level != 0
 
         result[:str]   = unescapeAll(str.slice(start...pos))
         result[:lines] = lines

data/lib/motion-markdown-it/index.rb

@@ -46,7 +46,7 @@ NORMALIZE_LINK = lambda do |url|
       end
     end
   end
- 
+
   return MDUrl::Encode.encode(MDUrl::Format.format(parsed))
 end
 
@@ -75,29 +75,29 @@ end
 
 #------------------------------------------------------------------------------
 # class MarkdownIt
-# 
+#
 # Main parser/renderer class.
-# 
+#
 # ##### Usage
-# 
+#
 # ```javascript
 # // node.js, "classic" way:
 # var MarkdownIt = require('markdown-it'),
 #     md = new MarkdownIt();
 # var result = md.render('# markdown-it rulezz!');
-# 
+#
 # // node.js, the same, but with sugar:
 # var md = require('markdown-it')();
 # var result = md.render('# markdown-it rulezz!');
-# 
+#
 # // browser without AMD, added to "window" on script load
 # // Note, there are no dash.
 # var md = window.markdownit();
 # var result = md.render('# markdown-it rulezz!');
 # ```
-# 
+#
 # Single line rendering, without paragraph wrap:
-# 
+#
 # ```javascript
 # var md = require('markdown-it')();
 # var result = md.renderInline('__markdown-it__ rulezz!');
@@ -106,6 +106,7 @@ end
 module MarkdownIt
   class Parser
     include MarkdownIt::Common::Utils
+    include MarkdownIt::Helpers
 
     attr_accessor   :inline
     attr_accessor   :block
@@ -116,7 +117,8 @@ module MarkdownIt
     attr_accessor   :normalizeLink
     attr_accessor   :normalizeLinkText
     attr_accessor   :linkify
-    
+    attr_accessor   :helpers
+
     # new MarkdownIt([presetName, options])
     # - presetName (String): optional, `commonmark` / `zero`
     # - options (Object)
@@ -158,7 +160,8 @@ module MarkdownIt
     #   `['«\xA0', '\xA0»', '‹\xA0', '\xA0›']` for French (including nbsp).
     # - __highlight__ - `nil`. Highlighter function for fenced code blocks.
     #   Highlighter `function (str, lang)` should return escaped HTML. It can also
-    #   return nil if the source was not changed and should be escaped externaly.
+    #   return nil if the source was not changed and should be escaped
+    #   externaly. If result starts with <pre... internal wrapper is skipped.
     #
     # ##### Example
     #
@@ -186,18 +189,35 @@ module MarkdownIt
     #   highlight: function (str, lang) {
     #     if (lang && hljs.getLanguage(lang)) {
     #       try {
-    #         return hljs.highlight(lang, str).value;
+    #         return hljs.highlight(lang, str, true).value;
     #       } catch (__) {}
     #     }
     #
-    #     try {
-    #       return hljs.highlightAuto(str).value;
-    #     } catch (__) {}
-    #
     #     return ''; // use external default escaping
     #   }
     # });
     # ```
+    #
+    # Or with full wrapper override (if you need assign class to `<pre>`):
+    #
+    # ```javascript
+    # var hljs = require('highlight.js') // https://highlightjs.org/
+    #
+    # // Actual default values
+    # var md = require('markdown-it')({
+    #   highlight: function (str, lang) {
+    #     if (lang && hljs.getLanguage(lang)) {
+    #       try {
+    #         return '<pre class="hljs"><code>' +
+    #                hljs.highlight(lang, str, true).value +
+    #                '</code></pre>';
+    #       } catch (__) {}
+    #     }
+    #
+    #     return '<pre class="hljs"><code>' + md.utils.escapeHtml(str) + '</code></pre>';
+    #   }
+    # });
+    # ```
     #-----------------------------------------------------------------------------
     def initialize(presetName = :default, options = {})
       if options.empty?
@@ -284,6 +304,19 @@ module MarkdownIt
 
       #  Expose utils & helpers for easy acces from plugins
 
+      # MarkdownIt#utils -> utils
+      #
+      # Assorted utility functions, useful to write plugins. See details
+      # [here](https://github.com/markdown-it/markdown-it/blob/master/lib/common/utils.js).
+      # this.utils = utils;
+
+      # MarkdownIt#helpers -> helpers
+      #
+      # Link components parser functions, useful to write plugins. See details
+      # [here](https://github.com/markdown-it/markdown-it/blob/master/lib/helpers).
+      # @helpers = assign({}, helpers);
+      @helpers = MarkdownIt::Helpers::HelperWrapper.new
+
       @options = {}
       configure(presetName)
       set(options) if options
@@ -340,6 +373,9 @@ module MarkdownIt
           if presets[:components][name][:rules]
             self.send(name).ruler.enableOnly(presets[:components][name][:rules])
           end
+          if presets[:components][name][:rules2]
+            self.send(name).ruler2.enableOnly(presets[:components][name][:rules2])
+          end
         end
       end
       return self
@@ -371,8 +407,10 @@ module MarkdownIt
       result << @core.ruler.enable(list, true)
       result << @block.ruler.enable(list, true)
       result << @inline.ruler.enable(list, true)
+      result << @inline.ruler2.enable(list, true)
       result.flatten!
-      
+
+
       missed = list.select {|name| !result.include?(name) }
       if !(missed.empty? || ignoreInvalid)
         raise StandardError, "MarkdownIt. Failed to enable unknown rule(s): #{missed}"
@@ -397,6 +435,7 @@ module MarkdownIt
       result << @core.ruler.disable(list, true)
       result << @block.ruler.disable(list, true)
       result << @inline.ruler.disable(list, true)
+      result << @inline.ruler2.disable(list, true)
       result.flatten!
 
       missed = list.select {|name| !result.include?(name) }
@@ -418,11 +457,12 @@ module MarkdownIt
     #
     # ```ruby
     # md = MarkdownIt::Parser.new
-    # md.use(MDPlugin::Iterator, 'foo_replace', 'text', 
+    # md.use(MDPlugin::Iterator, 'foo_replace', 'text',
     #        lambda {|tokens, idx|
     #          tokens[idx].content = tokens[idx].content.gsub(/foo/, 'bar')
     # })
     # ```
+    #------------------------------------------------------------------------------
     def use(plugin, *args)
       plugin.init_plugin(self, *args)
       return self
@@ -440,11 +480,13 @@ module MarkdownIt
     # AST).
     #
     # `env` is used to pass data between "distributed" rules and return additional
-    # metadata like reference info, needed for for renderer. It also can be used to
+    # metadata like reference info, needed for the renderer. It also can be used to
     # inject data in specific cases. Usually, you will be ok to pass `{}`,
     # and then pass updated object to renderer.
     #------------------------------------------------------------------------------
     def parse(src, env)
+      raise ArgumentError.new('Input data should be a String') if !src.is_a?(String)
+
       state = RulesCore::StateCore.new(src, self, env)
       @core.process(state)
       return state.tokens