slack-ruby-block-kit 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e3c462f9ce5026a4b9121b70e19a956af86b3920635cc88499c3f4ee0b49c8d
-  data.tar.gz: c7a671b81c0f5653ad7d81f1e4c6e19e2464c79e8159ae8dd910e6690aad3d4d
+  metadata.gz: 8a488cd59a504fbfd8a214f8ff50299a30dccc1050b825349b1c663deb667281
+  data.tar.gz: 21ff7316500a08924c6b3fbb4a08a4d2418f7edf099f6ac51751810b0084b86d
 SHA512:
-  metadata.gz: b9a94934add60e950ac68cf1e00186e3cb9811a35d8a6f3d37b80afb09f0772075956941587030cbfe1ae6d4735582f0a1a7904482ff84b7dc694bae4624dbef
-  data.tar.gz: 9205b0d1d67a2e82b518f39b4cf056960bd71adc9d756592dfe2a803268017eb629f8f5fe63d6eed4f5abbf395a02ed395d453c673bd20e04085e472f0019051
+  metadata.gz: 3ae1fffebc4396488b956afdfe06d312936ae027df6bc51b527afa3ed3e7877f7d98bf5aa4915240ca7bf63878432dc602783e42a2171fd99844d4f01880d68c
+  data.tar.gz: a78da5148ac91bbde126cd7d72a9f65dae16899270f2b34cfe8ec2c48d46689c11016217a2351ad3a500e6a201bc45e4d8f532919c3261038a3acba37ba43be9

data/CHANGELOG.md

@@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
-- Added new `Layout::Actions#checkboxes` method (#96 by @ryanwilsonperkin)
+- N/A
 
 ### Changed
 - N/A
@@ -26,7 +26,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - N/A
 
 
-[Unreleased]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.16.0...HEAD
+[Unreleased]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.17.0...HEAD
+
+
+---
+
+
+## [0.17.0] - 2021-06-28
+
+### Added
+- `Slack::BlockKit::Formatting` with utility functions for Slack text formatting (#98 by @CGA1123)
+
+
+[0.17.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.16.0...v0.17.0
 
 
 ---
@@ -36,6 +48,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 This release contains a breaking change on the `Layout::Actions` interface.
 
+### Added
+- Added new `Layout::Actions#checkboxes` method (#96 by @ryanwilsonperkin)
+
 ### Removed
 - `Layout::Actions#converstation_select` (use `#conversation_select` instead) (#97 by @ryanwilsonperkin)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slack-ruby-block-kit (0.16.0)
+    slack-ruby-block-kit (0.17.0)
 
 GEM
   remote: https://rubygems.org/
@@ -13,7 +13,7 @@ GEM
     diff-lcs (1.4.4)
     docile (1.3.5)
     dotenv (2.7.6)
-    faraday (1.4.2)
+    faraday (1.4.3)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)

data/lib/slack/block_kit/formatting.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    # Formatting contains some utility functions to help formatting text
+    #
+    # See: https://api.slack.com/reference/surfaces/formatting
+    module Formatting
+      extend self # rubocop:disable Style/ModuleFunction
+
+      DATE_FORMAT_TOKENS = [
+        # 2014-02-18
+        DATE_NUM = '{date_num}',
+
+        # February 18th, 2014
+        DATE = '{date}',
+
+        # Feb 18, 2014
+        DATE_SHORT = '{date_short}',
+
+        # Tuesday, February 18th, 2014
+        DATE_LONG = '{date_long}',
+
+        # February 18th, 2014 but uses "yesterday", "today", or "tomorrow"
+        # where
+        # appropriate
+        DATE_PRETTY = '{date_pretty}',
+
+        # Feb 18, 2014 but uses "yesterday", "today", or "tomorrow" where
+        # appropriate
+        DATE_SHORT_PRETTY = '{date_short_pretty}',
+
+        # Tuesday, February 18th, 2014 but uses "yesterday", "today", or
+        # "tomorrow" where appropriate
+        DATE_LONG_PRETTY = '{date_long_pretty}',
+
+        # 6:39 AM or 6:39 PM / 06:39 or 18:39 (depending on user preferences)
+        TIME = '{time}',
+
+        # 6:39:45 AM 6:39:42 PM / 06:39:45 or 18:39:42 (depending on user
+        # preferences)
+        TIME_SECS = '{time_secs}'
+      ].freeze
+
+      # Format a URL
+      #
+      # See: https://api.slack.com/reference/surfaces/formatting#links
+      def link(url, link_text: nil)
+        "<#{[url, link_text].compact.join('|')}>"
+      end
+
+      # Format a mailto link
+      #
+      # See: https://api.slack.com/reference/surfaces/formatting#links
+      def mailto(address, link_text: nil)
+        "<mailto:#{[address, link_text].compact.join('|')}>"
+      end
+
+      # Link a public channel
+      #
+      # See: https://api.slack.com/reference/surfaces/formatting#linking-channels
+      def channel(identifier)
+        "<##{identifier}>"
+      end
+
+      # Mention a user
+      #
+      # See: https://api.slack.com/reference/surfaces/formatting#mentioning-users
+      def user(identifier)
+        "<@#{identifier}>"
+      end
+
+      # Mention a group
+      #
+      # See: https://api.slack.com/reference/surfaces/formatting#mentioning-groups
+      def group(identifier)
+        "<!subteam^#{identifier}>"
+      end
+
+      # Mention @here (all active users in the current channel)
+      #
+      # See: https://api.slack.com/reference/surfaces/formatting#special-mentions
+      def at_here
+        # additional "|here" is for supporting very old mobile clients apparently!
+        '<!here|here>'
+      end
+
+      # Mention @channel (all users in the current channel)
+      #
+      # See: https://api.slack.com/reference/surfaces/formatting#special-mentions
+      def at_channel
+        '<!channel>'
+      end
+
+      # Mention @everyone (all users in #general)
+      #
+      # See: https://api.slack.com/reference/surfaces/formatting#special-mentions
+      def at_everyone
+        '<!everyone>'
+      end
+
+      # Localise a UNIX timestamp to the user's local timezone
+      #
+      # See: https://api.slack.com/reference/surfaces/formatting#date-formatting
+      def date(timestamp, token_string:, link: nil, fallback_text: nil)
+        datetime_str = [timestamp, token_string, link].compact.join('^')
+        str = [datetime_str, fallback_text].compact.join('|')
+
+        "<!date^#{str}>"
+      end
+
+      # Escape special characters (<,>,&) with their HTML entity code so
+      # Slack's text parsers knows to interpret them as literals.
+      #
+      # See: https://api.slack.com/reference/surfaces/formatting#escaping
+      def escape(text)
+        text
+          .gsub('&', '&amp;')
+          .gsub('>', '&gt;')
+          .gsub('<', '&lt;')
+      end
+    end
+  end
+end

data/lib/slack/block_kit/version.rb

@@ -2,6 +2,6 @@
 
 module Slack
   module BlockKit
-    VERSION = '0.16.0'
+    VERSION = '0.17.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-block-kit
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Christian Gregg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-23 00:00:00.000000000 Z
+date: 2021-06-28 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -58,6 +58,7 @@ files:
 - lib/slack/block_kit/element/static_select.rb
 - lib/slack/block_kit/element/timepicker.rb
 - lib/slack/block_kit/element/users_select.rb
+- lib/slack/block_kit/formatting.rb
 - lib/slack/block_kit/layout/actions.rb
 - lib/slack/block_kit/layout/context.rb
 - lib/slack/block_kit/layout/divider.rb