motion-markdown-it-plugins 8.4.1 → 8.4.2

data/lib/motion-markdown-it-plugins/emoji/plugin/data/light.rb

@@ -0,0 +1,161 @@
+module MotionMarkdownItPlugins
+  module EmojiPlugin
+    module Data
+      module Light
+        EMOJIES_DEF_LIGHT = {
+          "grinning" => "😀",
+          "smiley" => "😃",
+          "smile" => "😄",
+          "grin" => "😁",
+          "laughing" => "😆",
+          "satisfied" => "😆",
+          "sweat_smile" => "😅",
+          "joy" => "😂",
+          "blush" => "😊",
+          "innocent" => "😇",
+          "wink" => "😉",
+          "relieved" => "😌",
+          "heart_eyes" => "😍",
+          "kissing_heart" => "😘",
+          "kissing" => "😗",
+          "kissing_smiling_eyes" => "😙",
+          "kissing_closed_eyes" => "😚",
+          "yum" => "😋",
+          "stuck_out_tongue_winking_eye" => "😜",
+          "stuck_out_tongue_closed_eyes" => "😝",
+          "stuck_out_tongue" => "😛",
+          "sunglasses" => "😎",
+          "smirk" => "😏",
+          "unamused" => "😒",
+          "disappointed" => "😞",
+          "pensive" => "😔",
+          "worried" => "😟",
+          "confused" => "😕",
+          "persevere" => "😣",
+          "confounded" => "😖",
+          "tired_face" => "😫",
+          "weary" => "😩",
+          "angry" => "😠",
+          "rage" => "😡",
+          "pout" => "😡",
+          "no_mouth" => "😶",
+          "neutral_face" => "😐",
+          "expressionless" => "😑",
+          "hushed" => "😯",
+          "frowning" => "😦",
+          "anguished" => "😧",
+          "open_mouth" => "😮",
+          "astonished" => "😲",
+          "dizzy_face" => "😵",
+          "flushed" => "😳",
+          "scream" => "😱",
+          "fearful" => "😨",
+          "cold_sweat" => "😰",
+          "cry" => "😢",
+          "disappointed_relieved" => "😥",
+          "sob" => "😭",
+          "sweat" => "😓",
+          "sleepy" => "😪",
+          "sleeping" => "😴",
+          "mask" => "😷",
+          "smiling_imp" => "😈",
+          "smiley_cat" => "😺",
+          "smile_cat" => "😸",
+          "joy_cat" => "😹",
+          "heart_eyes_cat" => "😻",
+          "smirk_cat" => "😼",
+          "kissing_cat" => "😽",
+          "scream_cat" => "🙀",
+          "crying_cat_face" => "😿",
+          "pouting_cat" => "😾",
+          "fist_raised" => "✊",
+          "fist" => "✊",
+          "v" => "✌️",
+          "point_up" => "☝️",
+          "hand" => "✋",
+          "raised_hand" => "✋",
+          "cat" => "🐱",
+          "mouse" => "🐭",
+          "cow" => "🐮",
+          "monkey_face" => "🐵",
+          "star" => "⭐️",
+          "sparkles" => "✨",
+          "zap" => "⚡️",
+          "sunny" => "☀️",
+          "cloud" => "☁️",
+          "snowflake" => "❄️",
+          "umbrella" => "☔️",
+          "coffee" => "☕️",
+          "airplane" => "✈️",
+          "anchor" => "⚓️",
+          "watch" => "⌚️",
+          "phone" => "☎️",
+          "telephone" => "☎️",
+          "hourglass" => "⌛️",
+          "email" => "✉️",
+          "envelope" => "✉️",
+          "scissors" => "✂️",
+          "black_nib" => "✒️",
+          "pencil2" => "✏️",
+          "heart" => "❤️",
+          "aries" => "♈️",
+          "taurus" => "♉️",
+          "gemini" => "♊️",
+          "cancer" => "♋️",
+          "leo" => "♌️",
+          "virgo" => "♍️",
+          "libra" => "♎️",
+          "scorpius" => "♏️",
+          "sagittarius" => "♐️",
+          "capricorn" => "♑️",
+          "aquarius" => "♒️",
+          "pisces" => "♓️",
+          "eight_pointed_black_star" => "✴️",
+          "x" => "❌",
+          "hotsprings" => "♨️",
+          "exclamation" => "❗️",
+          "heavy_exclamation_mark" => "❗️",
+          "grey_exclamation" => "❕",
+          "question" => "❓",
+          "grey_question" => "❔",
+          "bangbang" => "‼️",
+          "interrobang" => "⁉️",
+          "part_alternation_mark" => "〽️",
+          "warning" => "⚠️",
+          "recycle" => "♻️",
+          "white_check_mark" => "✅",
+          "sparkle" => "❇️",
+          "eight_spoked_asterisk" => "✳️",
+          "negative_squared_cross_mark" => "❎",
+          "m" => "Ⓜ️",
+          "wheelchair" => "♿️",
+          "information_source" => "ℹ️",
+          "heavy_plus_sign" => "➕",
+          "heavy_minus_sign" => "➖",
+          "heavy_division_sign" => "➗",
+          "heavy_multiplication_x" => "✖️",
+          "tm" => "™️",
+          "copyright" => "©️",
+          "registered" => "®️",
+          "wavy_dash" => "〰️",
+          "curly_loop" => "➰",
+          "loop" => "➿",
+          "heavy_check_mark" => "✔️",
+          "ballot_box_with_check" => "☑️",
+          "white_circle" => "⚪️",
+          "black_circle" => "⚫️",
+          "black_small_square" => "▪️",
+          "white_small_square" => "▫️",
+          "black_medium_small_square" => "◾️",
+          "white_medium_small_square" => "◽️",
+          "black_medium_square" => "◼️",
+          "white_medium_square" => "◻️",
+          "black_large_square" => "⬛️",
+          "white_large_square" => "⬜️",
+          "black_joker" => "🃏",
+          "mahjong" => "🀄️"
+        }.freeze
+      end
+    end
+  end
+end

data/lib/motion-markdown-it-plugins/emoji/plugin/data/shortcuts.rb

@@ -0,0 +1,36 @@
+module MotionMarkdownItPlugins
+  module EmojiPlugin
+    module Data
+      module Shortcuts
+        EMOJIES_DEF_SHORTCUTS = {
+          'angry' =>            [ '>:(', '>:-(' ],
+          'blush' =>            [ ':")', ':-")' ],
+          'broken_heart' =>     [ '</3', '<\\3' ],
+          # :\ and :-\ not used because of conflict with markdown escaping
+          'confused' =>         [ ':/', ':-/' ], # twemoji shows question
+          'cry' =>              [ ":'(", ":'-(", ':,(', ':,-(' ],
+          'frowning' =>         [ ':(', ':-(' ],
+          'heart' =>            [ '<3' ],
+          'imp' =>              [ ']:(', ']:-(' ],
+          'innocent' =>         [ 'o:)', 'O:)', 'o:-)', 'O:-)', '0:)', '0:-)' ],
+          'joy' =>              [ ":')", ":'-)", ':,)', ':,-)', ":'D", ":'-D", ':,D', ':,-D' ],
+          'kissing' =>          [ ':*', ':-*' ],
+          'laughing' =>         [ 'x-)', 'X-)' ],
+          'neutral_face' =>     [ ':|', ':-|' ],
+          'open_mouth' =>       [ ':o', ':-o', ':O', ':-O' ],
+          'rage' =>             [ ':@', ':-@' ],
+          'smile' =>            [ ':D', ':-D' ],
+          'smiley' =>           [ ':)', ':-)' ],
+          'smiling_imp' =>      [ ']:)', ']:-)' ],
+          'sob' =>              [ ":,'(", ":,'-(", ';(', ';-(' ],
+          'stuck_out_tongue' => [ ':P', ':-P' ],
+          'sunglasses' =>       [ '8-)', 'B-)' ],
+          'sweat' =>            [ ',:(', ',:-(' ],
+          'sweat_smile' =>      [ ',:)', ',:-)' ],
+          'unamused' =>         [ ':s', ':-S', ':z', ':-Z', ':$', ':-$' ],
+          'wink' =>             [ ';)', ';-)' ]
+        }.freeze
+      end
+    end
+  end
+end

data/lib/motion-markdown-it-plugins/emoji/plugin/normalize_opts.rb

@@ -0,0 +1,72 @@
+module MotionMarkdownItPlugins
+  module EmojiPlugin
+    module NormalizeOpts
+      #------------------------------------------------------------------------------
+      def quoteRE(str)
+        str.gsub(/([.?*+^$\[\]\\(){}|-])/, '\\\\\1')
+      end
+
+      #------------------------------------------------------------------------------
+      def normalize_opts(options)
+        emojies   = stringify_keys(options[:defs])
+        shortcuts = stringify_keys(options[:shortcuts])
+
+        # Filter emojies by whitelist, if needed
+        if options[:enabled].length > 0
+          emojies = emojies.keys.reduce({}) do |acc, key|
+            if options[:enabled].include?(key)
+              acc[key] = emojies[key]
+            end
+
+            acc
+          end
+        end
+
+        # Flatten shortcuts to simple object: { alias: emoji_name }
+        shortcuts = shortcuts.keys.reduce({}) do |acc, key|
+          # Skip aliases for filtered emojies, to reduce regexp
+          next acc if !emojies[key]
+
+          if shortcuts[key].is_a?(Array)
+            shortcuts[key].each do |alias_value|
+              acc[alias_value] = key
+            end
+            next acc
+          end
+
+          acc[shortcuts[key]] = key
+          acc
+        end
+
+        # Compile regexp
+        names = emojies.keys
+                      .map { |name| ':' + name + ':' }
+                      .concat(shortcuts.keys)
+                      .sort
+                      .reverse
+                      .map { |name| quoteRE(name) }
+                      .join('|')
+
+        scanRE    = Regexp.new(names)
+        replaceRE = Regexp.new(names)
+
+        return {
+          defs:       emojies,
+          shortcuts:  shortcuts,
+          scanRE:     scanRE,
+          replaceRE:  replaceRE
+        }
+      end
+
+      private
+
+      # convert keys from symbols into strings
+      #------------------------------------------------------------------------------
+      def stringify_keys(symbol_hash)
+        result = {}
+        symbol_hash.each_key { |key| result[key.to_s] = symbol_hash[key] }
+        result
+      end
+    end
+  end
+end

data/lib/motion-markdown-it-plugins/emoji/plugin/render.rb

@@ -0,0 +1,9 @@
+module MotionMarkdownItPlugins
+  module EmojiPlugin
+    module Render
+      def emoji_html(tokens, idx) #, options, env
+        return tokens[idx].content
+      end
+    end
+  end
+end

data/lib/motion-markdown-it-plugins/emoji/plugin/replace.rb

@@ -0,0 +1,101 @@
+# Emojies & shortcuts replacement logic.
+#
+# Note: In theory, it could be faster to parse :smile: in inline chain and
+# leave only shortcuts here. But, who care...
+#------------------------------------------------------------------------------
+module MotionMarkdownItPlugins
+  module EmojiPlugin
+    module Replace
+      Z_RE_SRC  = UCMicro::Categories::Z::REGEX.source
+      P_RE_SRC  = UCMicro::Categories::P::REGEX.source
+      CC_RE_SRC = UCMicro::Categories::Cc::REGEX.source
+      ZPCC_RE   = Regexp.new([Z_RE_SRC, P_RE_SRC, CC_RE_SRC].join('|'))
+
+      #------------------------------------------------------------------------------
+      def create_rule(md, emojies, shortcuts, scanRE, replaceRE)
+        @emojies    = emojies
+        @shortcuts  = shortcuts
+        @scanRE     = scanRE
+        @replaceRE  = replaceRE
+
+        return lambda { |state| emoji_replace(state) }
+      end
+
+      #------------------------------------------------------------------------------
+      def splitTextToken(text, level, token_class)
+        last_pos  = 0
+        nodes     = []
+
+        text.gsub(@replaceRE) do |match|
+          match_data  = Regexp.last_match
+          offset      = match_data.offset(0)[0]
+          src         = match_data.string
+
+          # Validate emoji name
+          if @shortcuts.include?(match)
+            # replace shortcut with full name
+            emoji_name = @shortcuts[match]
+
+            # Don't allow letters before any shortcut (as in no ":/" in http://)
+            next if offset > 0 && !(ZPCC_RE =~ src[offset - 1])
+
+            # Don't allow letters after any shortcut
+            next if (offset + match.length < src.length) && !(ZPCC_RE =~ src[offset + match.length])
+          else
+            emoji_name = match.slice(1...-1)
+          end
+
+          # Add new tokens to pending list
+          if offset > last_pos
+            token         = token_class.new('text', '', 0)
+            token.content = text.slice(last_pos...offset)
+            nodes.push(token)
+          end
+
+          token         = token_class.new('emoji', '', 0)
+          token.markup  = emoji_name
+          token.content = @emojies[emoji_name]
+          nodes.push(token)
+
+          last_pos = offset + match.length
+        end
+
+        if last_pos < text.length
+          token         = token_class.new('text', '', 0)
+          token.content = text.slice(last_pos..-1)
+          nodes.push(token)
+        end
+
+        return nodes
+      end
+
+      #------------------------------------------------------------------------------
+      def emoji_replace(state)
+        blockTokens   = state.tokens
+        autolinkLevel = 0
+
+        0.upto(blockTokens.length - 1) do |j|
+          next if blockTokens[j].type != 'inline'
+          tokens = blockTokens[j].children
+
+          # We scan from the end, to keep position when new tags added.
+          # Use reversed logic in links start/end match
+          (tokens.length - 1).downto(0) do |i|
+            token = tokens[i]
+
+            if token.type == 'link_open' || token.type == 'link_close'
+              autolinkLevel -= token.nesting if token.info == 'auto'
+            end
+
+            if token.type == 'text' && autolinkLevel == 0 && @scanRE =~ token.content
+              # replace current node
+              blockTokens[j].children = tokens = arrayReplaceAt(
+                tokens, i, splitTextToken(token.content, token.level, MarkdownIt::Token)
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/motion-markdown-it-plugins/version.rb

@@ -1,5 +1,5 @@
 module MotionMarkdownItPlugins
 
-  VERSION = '8.4.1'
+  VERSION = '8.4.2'
 
 end

data/spec/emoji/emoji_spec.rb

@@ -0,0 +1,115 @@
+fixture_dir  = fixture_path('emoji/fixtures')
+
+#------------------------------------------------------------------------------
+describe 'markdown-it-emoji' do
+  describe 'default' do
+    md = MarkdownIt::Parser.new
+    md.use(MotionMarkdownItPlugins::Emoji)
+
+    generate(File.join(fixture_dir, 'default/emoji.txt'), md)
+    generate(File.join(fixture_dir, 'default/aliases.txt'), md)
+    generate(File.join(fixture_dir, 'full.txt'), md)
+  end
+
+  describe 'options' do
+    md = MarkdownIt::Parser.new
+    md.use(MotionMarkdownItPlugins::Emoji, {
+      defs: {
+        one:   '!!!one!!!',
+        fifty: '!!50!!'
+      },
+      shortcuts: {
+        fifty: [ ':50', '|50' ],
+        one:   ':uno'
+      }
+    })
+
+    generate(File.join(fixture_dir, 'options.txt'), md)
+  end
+
+  describe 'whitelist' do
+    md = MarkdownIt::Parser.new
+    md.use(MotionMarkdownItPlugins::Emoji, { enabled: [ 'smile', 'grin' ] })
+
+    generate(File.join(fixture_dir, 'whitelist.txt'), md)
+  end
+
+  describe 'autolinks' do
+    md = MarkdownIt::Parser.new({ linkify: true })
+    md.use(MotionMarkdownItPlugins::Emoji)
+
+    generate(File.join(fixture_dir, 'autolinks.txt'), md)
+  end
+end
+
+describe 'markdown-it-emoji-light' do
+  describe 'default' do
+    md = MarkdownIt::Parser.new
+    md.use(MotionMarkdownItPlugins::EmojiLight)
+
+    generate(File.join(fixture_dir, 'default/emoji.txt'), md)
+    generate(File.join(fixture_dir, 'default/aliases.txt'), md)
+    generate(File.join(fixture_dir, 'light.txt'), md)
+  end
+
+  describe 'options' do
+    md = MarkdownIt::Parser.new
+    md.use(MotionMarkdownItPlugins::EmojiLight, {
+      defs: {
+        one:   '!!!one!!!',
+        fifty: '!!50!!'
+      },
+      shortcuts: {
+        fifty: [ ':50', '|50' ],
+        one: ':uno'
+      }
+    })
+
+    generate(File.join(fixture_dir, 'options.txt'), md)
+  end
+
+  describe 'whitelist' do
+    md = MarkdownIt::Parser.new
+    md.use(MotionMarkdownItPlugins::EmojiLight, { enabled: [ 'smile', 'grin' ] })
+
+    generate(File.join(fixture_dir, 'whitelist.txt'), md)
+  end
+
+  describe 'autolinks' do
+    md = MarkdownIt::Parser.new({ linkify: true })
+    md.use(MotionMarkdownItPlugins::EmojiLight)
+
+    generate(File.join(fixture_dir, 'autolinks.txt'), md)
+  end
+end
+
+describe 'integrity' do
+  it 'all shortcuts should exist' do
+    MotionMarkdownItPlugins::EmojiPlugin::Data::Shortcuts::EMOJIES_DEF_SHORTCUTS.keys.each do |name|
+      expect(MotionMarkdownItPlugins::EmojiPlugin::Data::Full::EMOJIES_DEF_FULL[name]).not_to eq nil
+    end
+  end
+
+  it 'no chars with "uXXXX" names allowed' do
+    MotionMarkdownItPlugins::EmojiPlugin::Data::Full::EMOJIES_DEF_FULL.keys.each do |name|
+      expect(/^u[0-9a-b]{4,}$/ =~ name).to eq nil
+    end
+  end
+
+  it 'all light chars should exist' do
+
+    visible = File.read(File.join(fixture_dir, 'visible.txt'))
+
+    available = MotionMarkdownItPlugins::EmojiPlugin::Data::Light::EMOJIES_DEF_LIGHT.keys.map do |k|
+      MotionMarkdownItPlugins::EmojiPlugin::Data::Light::EMOJIES_DEF_LIGHT[k].gsub(/\uFE0F/, '')
+    end
+
+    missed = ''
+
+    visible.each_char do |ch|
+      missed << ch unless available.include?(ch)
+    end
+
+    expect(missed.length).to eq 0
+  end
+end