slack_transformer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7313982b9621e47723717517eb8a2a889c113270
+  data.tar.gz: 2282671a2714cd2653bfdc565f606a91d055d99c
+SHA512:
+  metadata.gz: 9ee0ac743cea68183d15c70822bc4a556b1fa9a3570547230a78f903118e48138767e31afc9e39efa6a101f41095369a3e6e3fe97813e28dcbb47af5b90ef1a8
+  data.tar.gz: bce104f1a1256d4a25d0d4459b7170011ed9d79a4b3f4874dfb711795b14b2d500ffbc67a63af22ebd6dd42c5f4ba486a8ac6e966c2ec975275fee30d03262a9

data/lib/slack_transformer.rb

@@ -0,0 +1,4 @@
+require 'slack_transformer/date'
+require 'slack_transformer/entities'
+require 'slack_transformer/html'
+require 'slack_transformer/slack'

data/lib/slack_transformer/date.rb

@@ -0,0 +1,41 @@
+require 'set'
+require 'time'
+
+module SlackTransformer
+  class Date
+    attr_reader :input, :format, :link, :fallback
+
+    class InvalidTokenError < StandardError; end
+
+    # See https://api.slack.com/docs/message-formatting#formatting_dates
+    DATE_FORMAT_TOKENS = Set.new(%w[
+      {date_num}
+      {date}
+      {date_short}
+      {date_long}
+      {date_pretty}
+      {date_short_pretty}
+      {date_long_pretty}
+      {time}
+      {time_secs}
+    ])
+
+    def initialize(input, format:, link: nil, fallback:)
+      @input = input
+      @format = format
+      @link = link
+      @fallback = fallback
+    end
+
+    def to_slack
+      tokens = format.scan(/(\{\w+\})/).first
+
+      if tokens
+        invalid_tokens = tokens.reject { |t| DATE_FORMAT_TOKENS.include?(t) }
+        raise InvalidTokenError, invalid_tokens.join(', ') unless invalid_tokens.empty?
+      end
+
+      "<!date^#{Time.parse(input.to_s).to_i}^#{format}#{"^#{link}" if link}|#{fallback}>"
+    end
+  end
+end

data/lib/slack_transformer/entities.rb

@@ -0,0 +1,18 @@
+module SlackTransformer
+  class Entities
+    attr_reader :input
+
+    def initialize(input)
+      @input = input
+    end
+
+    # See https://api.slack.com/docs/message-formatting#how_to_escape_characters
+    # NB: The order matters here. If you were to replace < with &lt; first, for
+    #   example, you'd end up with &amp;lt;
+    def to_slack
+      input.gsub('&', '&amp;')
+           .gsub('<', '&lt;')
+           .gsub('>', '&gt;')
+    end
+  end
+end

data/lib/slack_transformer/html.rb

@@ -0,0 +1,31 @@
+require 'slack_transformer/html/bold'
+require 'slack_transformer/html/code'
+require 'slack_transformer/html/italics'
+require 'slack_transformer/html/lists'
+require 'slack_transformer/html/preformatted'
+require 'slack_transformer/html/strikethrough'
+
+module SlackTransformer
+  class Html
+    attr_reader :input
+
+    TRANSFORMERS = [
+      SlackTransformer::Html::Bold,
+      SlackTransformer::Html::Italics,
+      SlackTransformer::Html::Strikethrough,
+      SlackTransformer::Html::Code,
+      SlackTransformer::Html::Preformatted,
+      SlackTransformer::Html::Lists
+    ]
+
+    def initialize(input)
+      @input = input
+    end
+
+    def to_slack
+      TRANSFORMERS.reduce(input) do |html, transformer|
+        transformer.new(html).to_slack
+      end
+    end
+  end
+end

data/lib/slack_transformer/html/bold.rb

@@ -0,0 +1,15 @@
+module SlackTransformer
+  class Html
+    class Bold
+      attr_reader :input
+
+      def initialize(input)
+        @input = input
+      end
+
+      def to_slack
+        input.gsub(/<\/?b>/, '*')
+      end
+    end
+  end
+end

data/lib/slack_transformer/html/code.rb

@@ -0,0 +1,15 @@
+module SlackTransformer
+  class Html
+    class Code
+      attr_reader :input
+
+      def initialize(input)
+        @input = input
+      end
+
+      def to_slack
+        input.gsub(/<\/?code>/, '`')
+      end
+    end
+  end
+end

data/lib/slack_transformer/html/italics.rb

@@ -0,0 +1,15 @@
+module SlackTransformer
+  class Html
+    class Italics
+      attr_reader :input
+
+      def initialize(input)
+        @input = input
+      end
+
+      def to_slack
+        input.gsub(/<\/?i>/, '_')
+      end
+    end
+  end
+end

data/lib/slack_transformer/html/lists.rb

@@ -0,0 +1,36 @@
+require 'nokogiri'
+
+module SlackTransformer
+  class Html
+    class Lists
+      attr_reader :input
+
+      def initialize(input)
+        @input = input
+      end
+
+      def to_slack
+        fragment = Nokogiri::HTML.fragment(input)
+
+        fragment.children.each do |child|
+          case child.name
+          when 'ul'
+            list = child.children.map do |c|
+              "• #{c.children.to_html}"
+            end
+
+            child.replace(list.join("\n"))
+          when 'ol'
+            list = child.children.map.with_index do |c, i|
+              "#{i + 1}. #{c.children.to_html}"
+            end
+
+            child.replace(list.join("\n"))
+          end
+        end
+
+        fragment.to_html
+      end
+    end
+  end
+end

data/lib/slack_transformer/html/preformatted.rb

@@ -0,0 +1,15 @@
+module SlackTransformer
+  class Html
+    class Preformatted
+      attr_reader :input
+
+      def initialize(input)
+        @input = input
+      end
+
+      def to_slack
+        input.gsub(/<\/?pre>/, '```')
+      end
+    end
+  end
+end

data/lib/slack_transformer/html/strikethrough.rb

@@ -0,0 +1,15 @@
+module SlackTransformer
+  class Html
+    class Strikethrough
+      attr_reader :input
+
+      def initialize(input)
+        @input = input
+      end
+
+      def to_slack
+        input.gsub(/<\/?s>/, '~')
+      end
+    end
+  end
+end

data/lib/slack_transformer/slack.rb

@@ -0,0 +1,35 @@
+require 'slack_transformer/slack/blockquote'
+require 'slack_transformer/slack/bold'
+require 'slack_transformer/slack/code'
+require 'slack_transformer/slack/italics'
+require 'slack_transformer/slack/preformatted'
+require 'slack_transformer/slack/quote'
+require 'slack_transformer/slack/strikethrough'
+
+module SlackTransformer
+  class Slack
+    attr_reader :input
+
+    TRANSFORMERS = [
+      SlackTransformer::Slack::Bold,
+      SlackTransformer::Slack::Italics,
+      SlackTransformer::Slack::Strikethrough,
+      SlackTransformer::Slack::Code,
+      SlackTransformer::Slack::Preformatted,
+      SlackTransformer::Slack::Quote,
+      SlackTransformer::Slack::Blockquote
+    ]
+
+    def initialize(input)
+      @input = input
+    end
+
+    def to_html
+      html = TRANSFORMERS.reduce(input) do |html, transformer|
+        transformer.new(html).to_html
+      end
+
+      "<p>#{html.gsub("\n", '<br>')}</p>"
+    end
+  end
+end

data/lib/slack_transformer/slack/blockquote.rb

@@ -0,0 +1,42 @@
+module SlackTransformer
+  class Slack
+    class Blockquote
+      attr_reader :input
+
+      PATTERN = /
+        ^
+
+        # start of line
+
+        ([*_~]?)
+
+        # optionally preceded by *, _, or ~
+
+        >{3}(.+)
+
+        # one or more of anything preceded by >
+
+        \1
+
+        # followed by *, _, or ~ if preceded by it
+
+        $
+
+        # end of line
+      /mx
+
+      def initialize(input)
+        @input = input
+      end
+
+      def to_html
+        input.gsub(PATTERN) do
+          outer = Regexp.last_match(1)
+          inner = Regexp.last_match(2).gsub("\n", '<br>')
+
+          "#{outer}<blockquote>#{inner}</blockquote>#{outer}"
+        end
+      end
+    end
+  end
+end

data/lib/slack_transformer/slack/bold.rb

@@ -0,0 +1,48 @@
+module SlackTransformer
+  class Slack
+    class Bold
+      attr_reader :input
+
+      PATTERN = /
+        (?<=^|\W)
+
+        # preceded by start of line or non-word character
+
+        (?<![*~`])
+
+        # but not *, ~, or `, which are mrkdwn delimiters
+        # Note: _ is also a mrkdwn delimiter, but it's included in \W because
+        # it's a word character.
+
+        ([_~]?)
+
+        # optionally preceded by _ or ~
+
+        \*((?:[^*]|(?<=[\w\s])\*+(?=\w))+)\*
+
+        # one or more of either not *, or one or more * preceded by word
+        # character or space and followed by word character, surrounded by *
+
+        \1
+
+        # followed by _ or ~ if preceded by it
+
+        (?![*`])
+
+        # not followed by * or `
+
+        (?=\W|$)
+
+        # followed by non-word character or end of line
+      /x
+
+      def initialize(input)
+        @input = input
+      end
+
+      def to_html
+        input.gsub(PATTERN, '\1<b>\2</b>\1')
+      end
+    end
+  end
+end

data/lib/slack_transformer/slack/code.rb

@@ -0,0 +1,43 @@
+module SlackTransformer
+  class Slack
+    class Code
+      attr_reader :input
+
+      PATTERN = /
+        (?<=^|\W|_)
+
+        # preceded by start of line, non-word character, or _
+
+        (?<!`)
+
+        # but not `
+
+        `([^`]+?)(`+)
+
+        # one or more of not ` preceded by ` followed by one or more `
+      /x
+
+      def initialize(input)
+        @input = input
+      end
+
+      def to_html
+        input.gsub(PATTERN) do |match|
+          closing_backticks = Regexp.last_match(2)
+          closing_backticks_length = closing_backticks.length
+          closing_backticks_remainder = closing_backticks_length % 3
+
+          if closing_backticks_remainder == 0
+            match
+          else
+            inner_text = Regexp.last_match(1)
+            inner_trailing_backticks = '`' * (closing_backticks_length / 3 * 3)
+            outer_trailing_backticks = '`' * (closing_backticks_remainder - 1)
+
+            "<code>#{inner_text}#{inner_trailing_backticks}</code>#{outer_trailing_backticks}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack_transformer/slack/italics.rb

@@ -0,0 +1,48 @@
+module SlackTransformer
+  class Slack
+    class Italics
+      attr_reader :input
+
+      PATTERN = /
+        (?<=^|\W)
+
+        # preceded by start of line or non-word character
+
+        (?<![*~`])
+
+        # but not *, ~, or `, which are mrkdwn delimiters
+        # Note: _ is also a mrkdwn delimiter, but it's included in \W because
+        # it's a word character.
+
+        ([*~]?)
+
+        # optionally preceded by * or ~
+
+        _((?:[^_]|(?<=[a-zA-Z0-9\s])_+(?=[a-zA-Z0-9]))+)_
+
+        # one or more of either not _, or one or more _ preceded by letter,
+        # number, or space and followed by letter or number, surrounded by _
+
+        \1
+
+        # followed by * or ~ if preceded by it
+
+        (?!```)
+
+        # not followed by ```
+
+        (?=\W|$)
+
+        # followed by non-word character or end of line
+      /x
+
+      def initialize(input)
+        @input = input
+      end
+
+      def to_html
+        input.gsub(PATTERN, '\1<i>\2</i>\1')
+      end
+    end
+  end
+end

data/lib/slack_transformer/slack/preformatted.rb

@@ -0,0 +1,45 @@
+module SlackTransformer
+  class Slack
+    class Preformatted
+      attr_reader :input
+
+      PATTERN = /
+        (?<=^|\W|_)
+
+        # preceded by start of line, non-word character, or _
+
+        (?<!~)
+
+        # but not ~
+
+        ([*_~]?)
+
+        # optionally preceded by *, _, or ~
+
+        ```(.+)```
+
+        # one or more of anything surrounded by ```
+
+        \1
+
+        # followed by *, _, or ~ if preceded by it
+
+        (?!~)
+
+        # not followed by ~
+
+        (?=\W|_|$)
+
+        # followed by non-word character, _, or end of line
+      /x
+
+      def initialize(input)
+        @input = input
+      end
+
+      def to_html
+        input.gsub(PATTERN, '\1<pre>\2</pre>\1')
+      end
+    end
+  end
+end

data/lib/slack_transformer/slack/quote.rb

@@ -0,0 +1,39 @@
+module SlackTransformer
+  class Slack
+    class Quote
+      attr_reader :input
+
+      PATTERN = /
+        ^
+
+        # start of line
+
+        ([*_~]?)
+
+        # optionally preceded by *, _, or ~
+
+        >(.+?)
+
+        # one or more of anything preceded by >
+
+        \1
+
+        # followed by *, _, or ~ if preceded by it
+
+        (?:\n|$)
+
+        # followed by newline or end of line
+      /x
+
+      def initialize(input)
+        @input = input
+      end
+
+      def to_html
+        input.gsub(PATTERN, '\1<blockquote>\2</blockquote>\1')
+             .gsub('</blockquote><blockquote>', '<br>')
+             .gsub(/(>(?:\n|$)){2,}/) { |match| match[0...-2] }
+      end
+    end
+  end
+end

data/lib/slack_transformer/slack/strikethrough.rb

@@ -0,0 +1,48 @@
+module SlackTransformer
+  class Slack
+    class Strikethrough
+      attr_reader :input
+
+      PATTERN = /
+        (?<=^|\W)
+
+        # preceded by start of line or non-word character
+
+        (?<![*~`])
+
+        # but not *, ~, or `, which are mrkdwn delimiters
+        # Note: _ is also a mrkdwn delimiter, but it's included in \W because
+        # it's a word character.
+
+        ([*_]?)
+
+        # optionally preceded by * or _
+
+        ~((?:[^~]|(?<=[\w\s])~+(?=\w))+)~
+
+        # one or more of either not ~, or one or more ~ preceded by word
+        # character or space and followed by word character, surrounded by ~
+
+        \1
+
+        # followed by * or _ if preceded by it
+
+        (?![*`])
+
+        # not followed by * or `
+
+        (?=\W|$)
+
+        # followed by non-word character or end of line
+      /x
+
+      def initialize(input)
+        @input = input
+      end
+
+      def to_html
+        input.gsub(PATTERN, '\1<s>\2</s>\1')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: slack_transformer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eric Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+description: 
+email:
+- eric@geteverwise.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/slack_transformer.rb
+- lib/slack_transformer/date.rb
+- lib/slack_transformer/entities.rb
+- lib/slack_transformer/html.rb
+- lib/slack_transformer/html/bold.rb
+- lib/slack_transformer/html/code.rb
+- lib/slack_transformer/html/italics.rb
+- lib/slack_transformer/html/lists.rb
+- lib/slack_transformer/html/preformatted.rb
+- lib/slack_transformer/html/strikethrough.rb
+- lib/slack_transformer/slack.rb
+- lib/slack_transformer/slack/blockquote.rb
+- lib/slack_transformer/slack/bold.rb
+- lib/slack_transformer/slack/code.rb
+- lib/slack_transformer/slack/italics.rb
+- lib/slack_transformer/slack/preformatted.rb
+- lib/slack_transformer/slack/quote.rb
+- lib/slack_transformer/slack/strikethrough.rb
+homepage: https://github.com/everwise/slack_transformer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Transform HTML into Slack-ready mrkdwn and back
+test_files: []