html-pipeline-mrkdwn 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6f8a11bf9d40b43c747109ca01c9f0c2b17b7718ed1595140690e9a5a96ba31
-  data.tar.gz: c9460d585926a5431f39937bf2fcedc952836786c6c7fb6ed0fa794abf694acc
+  metadata.gz: 0eb17fa9037f2b2f46094838495825879431ed801420ba13e955e2bf4e90cbd6
+  data.tar.gz: 46d2ac462fe75c75c1c0713173f2cb5f5c37867765297ea83b027dd01d4e9229
 SHA512:
-  metadata.gz: bcfb8cbfdd2960b89e11368e83b0012cfb010c468574dd67f1c535e0c6e4d074caf0a13c5a7ee9e4fbe39823c203dc4593cd4d0ba02c6b4b3084c0a119827b33
-  data.tar.gz: b084c17c07d5a914b460f6c4e5bb28d5d0cd4201fe68055523b4123a7c2bf7c5bdc7f4793c16e9a0a4296df994589e99a8aed581abfede18ee6ff145cd9c261f
+  metadata.gz: 319aa1921131f6809f05c1e3f2c7cb99f9cea546ff55f9d271ff29e154efa2830dce043599f8baad59f967f1ab19d3dc142fc811c5c735c2f0b00374ebf05afb
+  data.tar.gz: 6abbef7d6514383fc052009c0b29831b8fb054478790a16ed047375fe1a24acd012501538c689775f5933bbf39953cb515b15e7573b4384faa5c0540235057e2

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# Changelog
+
+## [0.1.2] - 2022-12-26
+
+- Split out code filter and apply after multiline code filter
+- Add a command line interface as bin/mrkdwn
+
+## [0.1.1] - 2022-12-25
+
+- Move mention and link filters before line break filter
+
 ## [0.1.0] - 2022-12-24
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    html-pipeline-mrkdwn (0.1.0)
+    html-pipeline-mrkdwn (0.1.2)
       escape_utils (~> 1.3.0)
       gemoji (~> 4.0.1)
       html-pipeline (~> 2.14.3)
@@ -25,8 +25,10 @@ GEM
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
+    mini_portile2 (2.8.1)
     minitest (5.16.3)
-    nokogiri (1.13.10-arm64-darwin)
+    nokogiri (1.13.10)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     parallel (1.22.1)
     parser (3.1.3.0)
@@ -76,4 +78,4 @@ DEPENDENCIES
   rubocop (~> 1.21)
 
 BUNDLED WITH
-   2.3.26
+   2.4.1

data/bin/mrkdwn

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require_relative "../pipeline"
+
+puts PIPELINE.to_html ARGV.shift

data/lib/html/pipeline/mrkdwn/mrkdwn_filter.rb

@@ -15,11 +15,9 @@ module HTML
     class Mrkdwn < Filter
       MULTILINE_CODE_PATTERN = /```(.+?)```/m.freeze
 
-      BLOCKQUOTE_PATTERN = /(^&gt;[^\n]*\n?)+/.freeze
-
-      LINE_BREAK_PATTERN = /\n/.freeze
+      CODE_PATTERN = /`(?=\S)(.+?)(?<=\S)`/.freeze
 
-      EMOJI_PATTERN = /:([\w+-]+):/.freeze
+      BLOCKQUOTE_PATTERN = /(^&gt;[^\n]*\n?)+/.freeze
 
       MENTION_PATTERN = /
         &lt;
@@ -34,28 +32,33 @@ module HTML
         &gt;
       /x.freeze
 
+      LINE_BREAK_PATTERN = /\n/.freeze
+
+      EMOJI_PATTERN = /:([\w+-]+):/.freeze
+
       STYLE_PATTERN = /
         ([`*_~])
         (?=\S)(.+?)(?<=\S)
         \1
       /x.freeze
 
-      IGNORE_PARENTS = %w[pre code].to_set
+      IGNORE_PARENTS = %w[pre code a].to_set
 
       ELEMENTS = {
         multiline_code: %w[```],
+        code: %w[`],
         blockquote: %w[&gt;],
-        line_break: %W[\n \r\n],
-        emoji: %w[:],
         mention: %w[@ # !],
         link: %w[&lt;],
-        style: %w[` * _ ~]
+        line_break: %W[\n \r\n],
+        emoji: %w[:],
+        style: %w[* _ ~]
       }.freeze
 
       def initialize(doc, context = nil, result = nil)
         super(doc, context, result)
 
-        @emoji_image_tag = ->(emoji) { emoji }
+        @emoji_image_tag = ->(emoji) { "<img src=\"#{emoji.image_filename}\" alt=\"#{emoji.name}\" class=\"emoji\">" }
         @slack_channels = {}
         @slack_users = {}
 
@@ -104,8 +107,8 @@ module HTML
         end
       end
 
-      def call_filter(sym, content)
-        method = "#{sym}_filter".to_sym
+      def call_filter(filter_name, content)
+        method = "#{filter_name}_filter".to_sym
         send method, content
       end
 
@@ -117,6 +120,18 @@ module HTML
         end
       end
 
+      def code_filter(content)
+        content.gsub CODE_PATTERN do |match|
+          text = Regexp.last_match[1]
+
+          if text&.match(/\A[`]+\Z/) # ignore runs of backquotes
+            match
+          else
+            "<code>#{text}</code>"
+          end
+        end
+      end
+
       def blockquote_filter(content)
         content.gsub BLOCKQUOTE_PATTERN do
           text = Regexp.last_match[0].chomp
@@ -126,35 +141,19 @@ module HTML
         end
       end
 
-      def line_break_filter(content)
-        content.gsub(LINE_BREAK_PATTERN, "<br>")
-      end
-
-      def emoji_filter(content)
-        content.gsub(EMOJI_PATTERN) do |match|
-          emoji = Emoji.find_by_alias(Regexp.last_match[1])
-
-          if emoji
-            emoji.raw || context.dig(:emoji_image_tag)&.call(emoji) || match
-          else
-            match
-          end
-        end
-      end
-
       def mention_filter(content)
         content.gsub MENTION_PATTERN do |match|
           mention = Regexp.last_match[1]
 
           (text, klass, prefix) =
             case mention
-            when /\A#(C.+)\Z/ # slack channel
+            when /\A#(C.+)\Z/ # slack channels
               [context.dig(:slack_channels, Regexp.last_match[1]) || Regexp.last_match[1], "channel", "#"]
 
-            when /\A@([UB].+)\Z/ # slack user or bot
+            when /\A@([UB].+)\Z/ # slack users or bots
               [context.dig(:slack_users, Regexp.last_match[1]) || Regexp.last_match[1], "user", "@"]
 
-            when /\A!(here|channel|everyone)\Z/ # special mention
+            when /\A!(here|channel|everyone)\Z/ # special mentions
               [Regexp.last_match[1], "mention", "@"]
             else
               nil
@@ -177,17 +176,31 @@ module HTML
         end
       end
 
+      def line_break_filter(content)
+        content.gsub(LINE_BREAK_PATTERN, "<br>")
+      end
+
+      def emoji_filter(content)
+        content.gsub(EMOJI_PATTERN) do |match|
+          emoji = Emoji.find_by_alias(Regexp.last_match[1])
+
+          if emoji
+            emoji.raw || context.dig(:emoji_image_tag)&.call(emoji) || match
+          else
+            match
+          end
+        end
+      end
+
       def style_filter(content)
         content.gsub STYLE_PATTERN do |match|
           style = Regexp.last_match[1]
           text = Regexp.last_match[2]
 
-          if text&.match(/\A[#{style}]+\Z/) # ignore runs of repeated style characters
+          if text&.match(/\A[#{style}]+\Z/) # ignore runs of style delimiters
             match
           else
             case style
-            when "`"
-              "<code>#{text}</code>"
             when "*"
               "<strong>#{style_filter(text)}</strong>"
             when "_"

data/lib/html/pipeline/mrkdwn/version.rb

@@ -3,7 +3,7 @@
 module HTML
   class Pipeline
     class Mrkdwn < Filter
-      VERSION = "0.1.0"
+      VERSION = "0.1.2"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-pipeline-mrkdwn
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Jason Gorst
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-24 00:00:00.000000000 Z
+date: 2022-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils
@@ -68,7 +68,8 @@ dependencies:
         version: 3.12.0
 description: An HTML::Pipeline filter for Slack's mrkdwn markup language.
 email: jason.gorst@me.com
-executables: []
+executables:
+- mrkdwn
 extensions: []
 extra_rdoc_files: []
 files:
@@ -81,6 +82,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/mrkdwn
 - lib/html/pipeline/mrkdwn.rb
 - lib/html/pipeline/mrkdwn/mrkdwn_filter.rb
 - lib/html/pipeline/mrkdwn/version.rb
@@ -107,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: An HTML::Pipeline filter for Slack's mrkdwn markup language.