html-pipeline-mrkdwn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6f8a11bf9d40b43c747109ca01c9f0c2b17b7718ed1595140690e9a5a96ba31
+  data.tar.gz: c9460d585926a5431f39937bf2fcedc952836786c6c7fb6ed0fa794abf694acc
+SHA512:
+  metadata.gz: bcfb8cbfdd2960b89e11368e83b0012cfb010c468574dd67f1c535e0c6e4d074caf0a13c5a7ee9e4fbe39823c203dc4593cd4d0ba02c6b4b3084c0a119827b33
+  data.tar.gz: b084c17c07d5a914b460f6c4e5bb28d5d0cd4201fe68055523b4123a7c2bf7c5bdc7f4793c16e9a0a4296df994589e99a8aed581abfede18ee6ff145cd9c261f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2022-12-24
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at jason.gorst@me.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in html-pipeline-mrkdwn.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    html-pipeline-mrkdwn (0.1.0)
+      escape_utils (~> 1.3.0)
+      gemoji (~> 4.0.1)
+      html-pipeline (~> 2.14.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    escape_utils (1.3.0)
+    gemoji (4.0.1)
+    html-pipeline (2.14.3)
+      activesupport (>= 2)
+      nokogiri (>= 1.4)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    minitest (5.16.3)
+    nokogiri (1.13.10-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.41.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  html-pipeline-mrkdwn!
+  rake (~> 13.0)
+  rspec (~> 3.12.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Jason Gorst
+
+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,52 @@
+# Html::Pipeline::Mrkdwn
+
+An [HTML::Pipeline](https://github.com/gjtorikian/html-pipeline) filter for Slack's
+[mrkdwn](https://api.slack.com/reference/surfaces/formatting#basics) markup language.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'html-pipeline-mrkdwn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install html-pipeline-mrkdwn
+
+## Usage
+
+Example:
+
+```ruby
+require 'html/pipeline'
+require 'html/pipeline/mrkdwn'
+
+filters = [
+  HTML::Pipeline::PlainTextInputFilter,
+  HTML::Pipeline::Mrkdwn
+]
+
+pipeline = HTML::Pipeline.new filters
+
+input = "*bold* will produce bold text"
+
+result = pipeline.call(input)
+
+puts result[:output].to_html
+# => "<div>\n<strong>bold</strong> will produce bold text</div>" 
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jasongorst/html-pipeline-mrkdwn.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

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

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+require "html/pipeline"
+require "gemoji"
+
+module HTML
+  class Pipeline
+    # HTML Filter for converting Slack's `mrkdwn` markup language.
+    #https://api.slack.com/reference/surfaces/formatting#basics
+    #
+    # Context options:
+    #   :emoji_image_tag - a Proc that returns an `img` tag for custom Emoji
+    #   :slack_channels - a hash of Slack channel ids and channel names
+    #   :slack_users - a hash of Slack user or bot ids and display names
+    class Mrkdwn < Filter
+      MULTILINE_CODE_PATTERN = /```(.+?)```/m.freeze
+
+      BLOCKQUOTE_PATTERN = /(^&gt;[^\n]*\n?)+/.freeze
+
+      LINE_BREAK_PATTERN = /\n/.freeze
+
+      EMOJI_PATTERN = /:([\w+-]+):/.freeze
+
+      MENTION_PATTERN = /
+        &lt;
+        ([@#!][a-z0-9][a-z0-9-]*)
+        &gt;
+      /ix.freeze
+
+      LINK_PATTERN = /
+        &lt;
+        ((?:http|mailto)[^|]+)
+        (?:\|(.+?))?
+        &gt;
+      /x.freeze
+
+      STYLE_PATTERN = /
+        ([`*_~])
+        (?=\S)(.+?)(?<=\S)
+        \1
+      /x.freeze
+
+      IGNORE_PARENTS = %w[pre code].to_set
+
+      ELEMENTS = {
+        multiline_code: %w[```],
+        blockquote: %w[&gt;],
+        line_break: %W[\n \r\n],
+        emoji: %w[:],
+        mention: %w[@ # !],
+        link: %w[&lt;],
+        style: %w[` * _ ~]
+      }.freeze
+
+      def initialize(doc, context = nil, result = nil)
+        super(doc, context, result)
+
+        @emoji_image_tag = ->(emoji) { emoji }
+        @slack_channels = {}
+        @slack_users = {}
+
+        @emoji_image_tag = @context[:emoji_image_tag] if @context[:emoji_image_tag]
+        @slack_channels = @context[:slack_channels] if @context[:slack_channels]
+        @slack_users = @context[:slack_users] if @context[:slack_users]
+      end
+
+      def call
+        ELEMENTS.each do |element, includes|
+          process_text_nodes(includes) { |content| call_filter(element, content) }
+        end
+
+        doc
+      end
+
+      def validate
+        if context[:emoji_image_tag] && !context[:emoji_image_tag].is_a?(Proc)
+          raise ArgumentError,
+                "context[:emoji_image_tag] should return a Proc that takes an Emoji object as in the 'gemoji' gem."
+        end
+
+        if context[:slack_channels] && !context[:slack_channels].is_a?(Hash)
+          raise ArgumentError,
+                "context[:slack_channels] should return a Hash whose keys are Slack channel ids and values are their names."
+        end
+
+        if context[:slack_users] && !context[:slack_users].is_a?(Hash)
+          raise ArgumentError,
+                "context[:slack_users] should return a Hash whose keys are Slack user or bot ids and values are their display names."
+        end
+      end
+
+      private
+
+      def process_text_nodes(includes)
+        doc.search(".//text()").each do |node|
+          content = node.to_html
+          next unless includes.any? { |str| content.include?(str) }
+          next if has_ancestor?(node, IGNORE_PARENTS)
+
+          html = yield content
+          next if html == content
+
+          node.replace(html)
+        end
+      end
+
+      def call_filter(sym, content)
+        method = "#{sym}_filter".to_sym
+        send method, content
+      end
+
+      def multiline_code_filter(content)
+        content.gsub MULTILINE_CODE_PATTERN do
+          text = Regexp.last_match[1].chomp
+
+          "<pre>#{text}</pre>"
+        end
+      end
+
+      def blockquote_filter(content)
+        content.gsub BLOCKQUOTE_PATTERN do
+          text = Regexp.last_match[0].chomp
+          text.gsub!(/^&gt;\s*/, "")
+
+          "<blockquote>#{blockquote_filter(text)}</blockquote>"
+        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
+              [context.dig(:slack_channels, Regexp.last_match[1]) || Regexp.last_match[1], "channel", "#"]
+
+            when /\A@([UB].+)\Z/ # slack user or bot
+              [context.dig(:slack_users, Regexp.last_match[1]) || Regexp.last_match[1], "user", "@"]
+
+            when /\A!(here|channel|everyone)\Z/ # special mention
+              [Regexp.last_match[1], "mention", "@"]
+            else
+              nil
+            end
+
+          if text
+            "<span class=\"#{klass}\">#{prefix}#{text}</span>"
+          else
+            match
+          end
+        end
+      end
+
+      def link_filter(content)
+        content.gsub LINK_PATTERN do
+          link = Regexp.last_match[1]
+          text = Regexp.last_match[2] || link
+
+          "<a class=\"link\" href=\"#{link}\">#{text}</a>"
+        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
+            match
+          else
+            case style
+            when "`"
+              "<code>#{text}</code>"
+            when "*"
+              "<strong>#{style_filter(text)}</strong>"
+            when "_"
+              "<em>#{style_filter(text)}</em>"
+            when "~"
+              "<del>#{style_filter(text)}</del>"
+            else
+              nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module HTML
+  class Pipeline
+    class Mrkdwn < Filter
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/html/pipeline/mrkdwn.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "mrkdwn/mrkdwn_filter"
+require_relative "mrkdwn/version"

data/pipeline.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# A default pipeline for Slack messages using mrkdwn.
+
+require "bundler/setup"
+require "html/pipeline/mrkdwn"
+
+PIPELINE = HTML::Pipeline.new [
+  HTML::Pipeline::PlainTextInputFilter,
+  HTML::Pipeline::Mrkdwn
+]

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: html-pipeline-mrkdwn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Gorst
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: escape_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: gemoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+description: An HTML::Pipeline filter for Slack's mrkdwn markup language.
+email: jason.gorst@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/html/pipeline/mrkdwn.rb
+- lib/html/pipeline/mrkdwn/mrkdwn_filter.rb
+- lib/html/pipeline/mrkdwn/version.rb
+- pipeline.rb
+homepage: https://github.com/jasongorst/html-pipeline-mrkdwn
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jasongorst/html-pipeline-mrkdwn
+  source_code_uri: https://github.com/jasongorst/html-pipeline-mrkdwn.git
+  changelog_uri: https://github.com/jasongorst/html-pipeline-mrkdwn/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: An HTML::Pipeline filter for Slack's mrkdwn markup language.
+test_files: []