slack-ruby-block-kit 0.23.0 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c1823b83c807b7c74ed6dc2a6c9adfd1945de04ab0cc6728d2d0864e0e6ed2e
-  data.tar.gz: 2b90261eac6e5b840d92b9d6492ef59c7a98558104c95c3b0cd3821fe8a00619
+  metadata.gz: 9ab3214e279c311f218493c2d98aa4662d1a121d9c005f6fa0e77909503e66ae
+  data.tar.gz: b88b6e9b0aeeb0dd6d245d5abf1d12d8558efe6c9c5b6b4a48ae49ab79e58b09
 SHA512:
-  metadata.gz: 41292e69ae30c232a9363259bc393cad93bac9b795a2e1bfc96c378f439072cb60947df3992c1f5a62a551bfa40c140a8f0b65fbfe659497355f524ad105bae0
-  data.tar.gz: fed6537c6e306897a06b34a676fef07289694c36350e097cbe5f7f45abe2493c92f0175c5d5a7d7f7e6e9b410aa43bb1f0a226f7540de59f3fe37acd8911a208
+  metadata.gz: 4bba843df81284b916f1a230e8b46e70c0a61afa1843975f2f01914420621829b37326275a8d358d6451f16f2906375beed0b7b4ca2833029c535d07bf16d6a0
+  data.tar.gz: ec3cea5f071e44788cc4ff044c6089c2f15ef7e0b52b1b58a1086f2c6e597adcc354c5935f5c5ddf5b7fc791ca3bdcf4d57a4cd5435a0304259d336590386b68

data/.github/workflows/ci.yml

@@ -8,12 +8,16 @@ on:
 
 jobs:
   build:
+    permissions:
+      contents: write
+      id-token: write
+
     runs-on: ubuntu-latest
     continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6', '2.7', '3.0', '3.1' ]
+        ruby: [ '2.7', '3.0', '3.1', '3.2', '3.3' ]
         experimental: [ false ]
     name: Ruby ${{ matrix.ruby }}
     steps:
@@ -21,7 +25,9 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - run: gem install bundler:2.1.4
-      - run: bundle install
+          bundler-cache: true
+      - uses: codecov/codecov-action@v4
+        with:
+          use_oidc: true
       - run: bundle exec rspec --format progress
       - run: bundle exec rubocop

data/.github/workflows/release.yml

@@ -2,30 +2,18 @@ name: Release
 
 on:
   workflow_dispatch:
-    inputs:
-      otp:
-        name: 'RubyGems OTP Code'
-        required: true
-
 jobs:
   release:
+    permissions:
+      contents: write
+      id-token: write
+
     name: Release
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
-      - name: Mask OTP
-        run: |
-          OTP=$(jq -r '.inputs.otp' $GITHUB_EVENT_PATH)
-          echo "::add-mask::$OTP"
-      - run: gem update --system
-      - run: git config --global user.email github-action@users.noreply.github.com
-      - run: git config --global user.name GitHub Actions
-      - run: git config --global user.password ${{ github.token }}
-      - run: bundle install
-      - run: bundle exec rake release
-        env:
-          GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
-          GEM_HOST_OTP_CODE: ${{ github.event.inputs.otp }}
+          ruby-version: 3.3
+          bundler-cache: true
+      - uses: rubygems/release-gem@v1

data/CHANGELOG.md

@@ -25,6 +25,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Security
 - N/A
 
+## [0.25.0] - 2024-11-22
+
+### Added
+- Allow setting `description:` to `StaticSelect`, `MultiStaticSelect`, `RadioButtons`, & any `OptionGroup`s. (#195 by @resputin)
+
+
+## [0.24.0] - 2024-04-07
+
+### Added
+
+- Added support for Rich Text Block via `Slack::BlockKit::Layout::RichText` (#185 by @GetOutOfMyBakery)
+
+
+### Changed
+- Codecov reporting via GitHub Actions OIDC (#188 by @CGA1123)
+- Rubygems releasing via GitHub Actions OIDC (#188 by @CGA1123)
 
 ## [0.23.0] - 2023-08-07
 
@@ -181,7 +197,10 @@ This release contains a breaking change on the `Layout::Actions` interface.
 - Fixed initial options in multi select blocks (#46 by @caalberts)
 
 
-[Unreleased]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.22.0...HEAD
+[Unreleased]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.25.0...HEAD
+[0.25.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.24.0...v0.25.0
+[0.24.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.23.0...v0.24.0
+[0.23.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.22.0...v0.23.0
 [0.22.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.21.0...v0.22.0
 [0.21.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.20.0...v0.21.0
 [0.20.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.19.0...v0.20.0

data/Gemfile

@@ -7,12 +7,15 @@ gemspec
 gem 'dotenv', '~> 2'
 gem 'faraday', '~> 1'
 gem 'pry', '~> 0.14'
+gem 'racc'
 gem 'rake', '~> 13'
 gem 'rspec', '~> 3'
 gem 'rspec_junit_formatter', '~> 0.6'
 
-gem 'codecov', '~> 0.6', require: false
+gem 'debug', '~> 1.9', require: false
+gem 'retest', '~> 1.13', require: false
 gem 'rubocop', '~> 1', require: false
 gem 'rubocop-rake', '~> 0.6', require: false
 gem 'rubocop-rspec', '~> 2', require: false
-gem 'simplecov', '~> 0.21', require: false
+gem 'simplecov', '~> 0.22', require: false
+gem 'simplecov-cobertura', require: false

data/Gemfile.lock

@@ -1,17 +1,18 @@
 PATH
   remote: .
   specs:
-    slack-ruby-block-kit (0.23.0)
+    slack-ruby-block-kit (0.25.0)
       zeitwerk (~> 2.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    codecov (0.6.0)
-      simplecov (>= 0.15, < 0.22)
     coderay (1.1.3)
-    diff-lcs (1.5.0)
+    debug (1.9.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.5.1)
     docile (1.4.0)
     dotenv (2.8.1)
     faraday (1.10.3)
@@ -37,31 +38,56 @@ GEM
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
     faraday-retry (1.0.3)
+    ffi (1.16.3)
+    io-console (0.7.2)
+    irb (1.12.0)
+      rdoc
+      reline (>= 0.4.2)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     method_source (1.0.0)
     multipart-post (2.3.0)
+    observer (0.1.2)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    psych (5.1.2)
+      stringio
+    racc (1.8.0)
     rainbow (3.1.1)
-    rake (13.0.6)
+    rake (13.2.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rdoc (6.6.3.1)
+      psych (>= 4.0.0)
     regexp_parser (2.3.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.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    reline (0.4.3)
+      io-console (~> 0.5)
+    retest (1.13.2)
+      listen (~> 3.9)
+      observer (~> 0.1)
+      string-similarity (~> 2.1)
+      tty-option (~> 0.1)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.0)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
     rubocop (1.28.2)
@@ -81,32 +107,43 @@ GEM
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (2.1.0)
+      rexml
+      simplecov (~> 0.19)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
+    simplecov_json_formatter (0.1.4)
+    string-similarity (2.1.0)
+    stringio (3.1.0)
+    strscan (3.1.0)
+    tty-option (0.3.0)
     unicode-display_width (2.1.0)
-    zeitwerk (2.6.11)
+    zeitwerk (2.6.18)
 
 PLATFORMS
   ruby
   x86_64-darwin-19
+  x86_64-darwin-23
   x86_64-linux
 
 DEPENDENCIES
-  codecov (~> 0.6)
+  debug (~> 1.9)
   dotenv (~> 2)
   faraday (~> 1)
   pry (~> 0.14)
+  racc
   rake (~> 13)
+  retest (~> 1.13)
   rspec (~> 3)
   rspec_junit_formatter (~> 0.6)
   rubocop (~> 1)
   rubocop-rake (~> 0.6)
   rubocop-rspec (~> 2)
-  simplecov (~> 0.21)
+  simplecov (~> 0.22)
+  simplecov-cobertura
   slack-ruby-block-kit!
 
 BUNDLED WITH

data/README.md

@@ -67,8 +67,8 @@ blocks = Slack::BlockKit.blocks do |b|
   b.append(a_prebuilt_block)
 end
 
+body = { blocks: blocks.as_json }
 webhook_url = 'https://hooks.slack.com/services/your/webhook/url'
-body = { blocks: blocks.as_json, text: 'New block message!' }
 
 response = Faraday.post(
   webhook_url,
@@ -81,8 +81,10 @@ This will create a message like this:
 
 ![example block message](https://git.io/fjDWR)
 
-You can also check out the [`slackerduty`](https://github.com/CGA1123/slackerduty) project for some example,
-[`Slackerduty::Alert`](https://github.com/CGA1123/slackerduty/blob/b33d708124ddf36d1432080ba7e16e66fefa6993/lib/slackerduty/alert.rb#L28-L34) and [`Slackerduty::Blocks`](https://github.com/CGA1123/slackerduty/blob/master/lib/slackerduty/blocks) may be helpful places to start.
+See [`./examples`](./examples/), and [`./examples/README.md`](./examples/README.md), for more worked examples and guidance.
+
+You can also check out the [`slackerduty`](https://github.com/CGA1123/slackerduty) project for some more examples,
+[`Slackerduty::Alert`](https://github.com/CGA1123/slackerduty/blob/b33d708124ddf36d1432080ba7e16e66fefa6993/lib/slackerduty/alert.rb#L28-L34) and [`Slackerduty::Blocks`](https://github.com/CGA1123/slackerduty/blob/¦master/lib/slackerduty/blocks) may be helpful places to start.
 
 ## Contributing
 
@@ -96,12 +98,13 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Releasing
 
-Releasing is automated via the `.github/workflows/release.yml` which allows for
-an OTP code to be passed in to authorize the release with MFA. If GitHub
-Actions is running slow it might take another attempt to make sure the OTP code
-is still valid when the workflow tries to push.
+Releasing is automated via the `.github/workflows/release.yml` which runs via
+[Trusted Publishing] authenticating with RubyGems via GitHub Action's OIDC
+integration.
 
 - Update `CHANGELOG` for the latest version (remember to update the comparison links + add in an `Unreleased` section again)
 - Update `lib/slack/block_kit/version.rb` and run `bundle` to update the `Gemfile.lock`
 - Push that!
 - Run the `Release` workflow
+
+[Trusted Publishing]: https://guides.rubygems.org/trusted-publishing/

data/examples/README.md

@@ -0,0 +1,18 @@
+# Examples
+
+These example files demonstrate worked examples of how to use the gem.  
+They are written in a way that you can:
+- send the messages to your own Slack workspace, when a valid Slack `webhook_url` has been provided (see `./config.rb`)
+- copy and paste the output to Slack's [Block Builder Kit](https://app.slack.com/block-kit-builder) to validate the output without having to send a message to Slack
+
+> [!NOTE]
+> There are some values that need to be valid otherwise Slack, or the Block Builder Kit UI, will return a warning reporting the block output is invalid
+
+## How to use
+1. Update `./config.rb`
+1. Run `bundle exec examples/simple_example.rb`
+
+> [!TIP]
+> When using [Block Builder Kit](https://app.slack.com/block-kit-builder) to validate the output, set `SUPPRESS_WEBHOOK_MESSAGE=true` to suppress lines that would invalid the output, e.g.:
+> `SUPPRESS_WEBHOOK_MESSAGE=true examples/simple_example.rb | pbcopy` # on Mac
+> `SUPPRESS_WEBHOOK_MESSAGE=true examples/simple_example.rb | xclip -selection clipboard` # on Linux

data/examples/comprehensive_rich_text_blocks.rb

@@ -0,0 +1,121 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/slack-ruby-block-kit'
+require_relative './config'
+require_relative './example_helper'
+require 'json'
+
+# rubocop:disable Metrics/BlockLength
+blocks = Slack::BlockKit.blocks do |b|
+  b.rich_text do |rt|
+    rt.rich_text_section do |rts|
+      rts.text(text: "Bold text\n", styles: ['bold'])
+      rts.text(text: "Italic text\n", styles: ['italic'])
+      rts.text(text: "strikethrough text\n", styles: ['strike'])
+      rts.text(text: "This is a code block!\n", styles: ['code'])
+      rts.text(
+        text: "This text has multiple styling\n",
+        styles: %w[
+          bold
+          italic
+          strike
+        ]
+      )
+    end
+  end
+
+  b.divider
+
+  b.rich_text do |rt|
+    rt.rich_text_section do |rts|
+      rts.text(text: 'Tagging a user:')
+      rts.user(user_id: Config.user_id)
+      rts.text(text: "\nTagging a user with some styling:")
+      rts.user(user_id: Config.user_id, styles: %w[bold italic])
+      rts.text(text: "\n")
+    end
+  end
+
+  b.divider
+
+  b.rich_text do |rt|
+    rt.rich_text_section do |rts|
+      rts.text(text: 'Tagging a user group:')
+      rts.usergroup(usergroup_id: Config.usergroup_id)
+      rts.text(text: "\nTagging a user group with some styling:")
+      rts.usergroup(usergroup_id: Config.usergroup_id, styles: ['bold'])
+      rts.text(text: "\n")
+    end
+  end
+
+  b.divider
+
+  b.rich_text do |rt|
+    rt.rich_text_section do |rts|
+      rts.text(text: 'Channel tag: ')
+      rts.channel(channel_id: Config.channel_id)
+      rts.text(text: "\n")
+    end
+
+    rt.rich_text_section do |rts|
+      rts.text(text: 'Link to a great repo: ')
+      rts.emoji(name: 'point_right')
+      rts.link(url: 'https://github.com/CGA1123/slack-ruby-block-kit')
+      rts.emoji(name: 'point_left')
+      rts.text(text: "\n")
+    end
+
+    rt.rich_text_section do |rts|
+      rts.emoji(name: 'muscle')
+      rts.link(
+        url: 'https://github.com/CGA1123/slack-ruby-block-kit',
+        text: 'Link with alternative title',
+        unsafe: true,
+        styles: %w[
+          bold
+          italic
+        ]
+      )
+      rts.emoji(name: 'muscle-two')
+      rts.text(text: "\n")
+    end
+  end
+
+  b.divider
+
+  b.rich_text do |rt|
+    rt.rich_text_list(style: 'bullet', indent: 1, offset: 1, border: 1) do |rtl|
+      rtl.rich_text_section do |rts|
+        rts.text(text: "Rich text\n", styles: %w[bold italic strike])
+        rts.text(text: "strikethrough text\n", styles: ['strike'])
+      end
+
+      rtl.rich_text_section do |rts|
+        rts.text(text: "strikethrough text\n", styles: ['strike'])
+        rts.text(text: "code block text\n", styles: ['code'])
+      end
+    end
+
+    rt.rich_text_list(style: 'ordered', indent: 2, offset: 2, border: 1) do |rtl|
+      rtl.rich_text_section do |rts|
+        rts.text(text: "Some text\n", styles: ['bold'])
+        rts.text(text: "Some more text\n", styles: ['strike'])
+      end
+    end
+
+    rt.rich_text_preformatted(border: 1) do |rtp|
+      rtp.text(text: 'Some text', styles: %w[bold italic])
+    end
+
+    rt.rich_text_quote(border: 1) do |rtq|
+      rtq.text(text: 'Some more text', styles: %w[bold strike])
+    end
+  end
+end
+# rubocop:enable Metrics/BlockLength
+
+body = { blocks: blocks.as_json }
+puts JSON.pretty_generate(body)
+
+ExampleHelper.post_to_slack(body)

data/examples/config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# When using Slack's Block Builder Kit, https://app.slack.com/block-kit-builder, there are some values that need
+# to be valid otherwise the UI will return a warning and report the block as being invalid.
+
+# Store and populate any other examples here, and use throughout 'examples/' scripts.
+
+module Config
+  class << self
+    attr_accessor :channel_id, :user_id, :usergroup_id, :webhook_url
+  end
+
+  self.channel_id = 'CL9QH354H'
+  self.user_id = 'URLQ55EMB'
+  self.usergroup_id = 'SBR3Q0B2T'
+
+  # Uncomment and provide a valid webook to post to `examples/` scripts to Slack:
+  # self.webhook_url = 'https://hooks.slack.com/services/your/webhook/url'
+end

data/examples/example_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module ExampleHelper
+  def self.print_output(line)
+    warn line unless ENV.fetch('SUPPRESS_WEBHOOK_MESSAGE', nil) == 'true'
+  end
+
+  def self.post_to_slack(body)
+    if Config.webhook_url
+      print_output 'Posting to Slack ...'
+      Faraday.post(
+        Config.webhook_url,
+        body.to_json,
+        'Content-Type' => 'application/json'
+      )
+    else
+      print_output 'Set a "webhook_url" in "./config.rb" in order to test sending this message to Slack.'
+    end
+  end
+end

data/examples/simple_example.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/slack-ruby-block-kit'
+require_relative './config'
+require_relative './example_helper'
+require 'json'
+
+a_prebuilt_block = Slack::BlockKit::Layout::Section.new
+text = Slack::BlockKit::Composition::Mrkdwn.new(text: ':wave: *hello*')
+an_image = Slack::BlockKit::Element::Image.new(image_url: 'https://git.io/fjDW8', alt_text: 'a picture')
+a_prebuilt_block.accessorise(an_image)
+a_prebuilt_block.text = text
+
+blocks = Slack::BlockKit.blocks do |b|
+  b.section do |s|
+    s.plain_text(text: 'Some plain text message!')
+    s.button(text: 'A button that is important', style: 'primary', action_id: 'id')
+  end
+
+  b.divider
+
+  b.context do |c|
+    c.mrkdwn(text: '_some italicised text for context_')
+  end
+
+  b.append(a_prebuilt_block)
+end
+
+body = { blocks: blocks.as_json }
+puts JSON.pretty_generate(body)
+
+ExampleHelper.post_to_slack(body)

data/examples/simple_rich_text_blocks.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/slack-ruby-block-kit'
+require_relative './config'
+require_relative './example_helper'
+require 'json'
+
+a_prebuilt_block = Slack::BlockKit::Layout::RichText.new
+bold_rich_text_section = Slack::BlockKit::Layout::RichText::RichTextSection.new.text(text: 'Bold text', styles: ['bold'])
+a_prebuilt_block.append(bold_rich_text_section)
+
+italic_rich_text_section = Slack::BlockKit::Layout::RichText::RichTextSection.new.text(text: 'Italic text', styles: ['italic'])
+a_prebuilt_block.append(italic_rich_text_section)
+
+channel_rich_text = Slack::BlockKit::Layout::RichText::RichTextSection.new.channel(channel_id: Config.channel_id, styles: %w[bold italic])
+a_prebuilt_block.append(channel_rich_text)
+
+blocks = Slack::BlockKit.blocks do |b|
+  b.append(a_prebuilt_block)
+end
+
+body = { blocks: blocks.as_json }
+puts JSON.pretty_generate(body)
+
+ExampleHelper.post_to_slack(body)

data/lib/slack/block_kit/blocks.rb

@@ -55,6 +55,14 @@ module Slack
         append(block)
       end
 
+      def rich_text(block_id: nil)
+        block = Layout::RichText.new(block_id: block_id)
+
+        yield(block) if block_given?
+
+        append(block)
+      end
+
       def video(alt_text:, thumbnail_url:, video_url:, title:, description:, **optional_args)
         block = Layout::Video.new(
           alt_text: alt_text,

data/lib/slack/block_kit/composition/option_group.rb

@@ -17,8 +17,8 @@ module Slack
           yield(self) if block_given?
         end
 
-        def option(text:, value:, emoji: nil, initial: false)
-          @options << Option.new(text: text, value: value, emoji: emoji, initial: initial)
+        def option(text:, value:, description: nil, emoji: nil, initial: false)
+          @options << Option.new(text: text, value: value, description: description, emoji: emoji, initial: initial)
 
           self
         end

data/lib/slack/block_kit/element/multi_static_select.rb

@@ -37,11 +37,12 @@ module Slack
           yield(self) if block_given?
         end
 
-        def option(value:, text:, initial: false, emoji: nil)
+        def option(value:, text:, description: nil, initial: false, emoji: nil)
           @options ||= []
           @options << Composition::Option.new(
             value: value,
             text: text,
+            description: description,
             emoji: emoji,
             initial: initial
           )

data/lib/slack/block_kit/element/radio_buttons.rb

@@ -21,10 +21,11 @@ module Slack
           yield(self) if block_given?
         end
 
-        def option(value:, text:, initial: false, emoji: nil)
+        def option(value:, text:, description: nil, initial: false, emoji: nil)
           option = Composition::Option.new(
             value: value,
             text: text,
+            description: description,
             initial: initial,
             emoji: emoji
           )

data/lib/slack/block_kit/element/static_select.rb

@@ -27,11 +27,12 @@ module Slack
           yield(self) if block_given?
         end
 
-        def option(value:, text:, initial: false, emoji: nil)
+        def option(value:, text:, description: nil, initial: false, emoji: nil)
           @options ||= []
           @options << Composition::Option.new(
             value: value,
             text: text,
+            description: description,
             emoji: emoji,
             initial: initial
           )

data/lib/slack/block_kit/element/timepicker.rb

@@ -16,7 +16,7 @@ module Slack
         TYPE = 'timepicker'
 
         def initialize(action_id:, placeholder: nil, initial: nil, emoji: nil, focus_on_load: nil)
-          @placeholder = placeholder_text(placeholder, emoji) if placeholder
+          @placeholder = placeholder_text(placeholder, emoji)
           @initial_time = initial
           @action_id = action_id
           @focus_on_load = focus_on_load

data/lib/slack/block_kit/layout/rich_text/rich_text_elements/channel.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      class RichText
+        module RichTextElements
+          # https://api.slack.com/reference/block-kit/blocks#element-types
+          class Channel
+            include RichTextElements::StyleHelper
+            TYPE = 'channel'
+            VALID_STYLES = %w[bold italic strike highlight client_highlight unlink].freeze
+
+            def initialize(channel_id:, styles: [])
+              @channel_id = channel_id
+              @styles = styles
+              validate_styles(styles, VALID_STYLES)
+            end
+
+            def as_json(*)
+              {
+                type: TYPE,
+                channel_id: @channel_id,
+                style: styles_as_json(@styles)
+              }.compact
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/rich_text/rich_text_elements/emoji.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      class RichText
+        module RichTextElements
+          # https://api.slack.com/reference/block-kit/blocks#element-types
+          class Emoji
+            TYPE = 'emoji'
+
+            def initialize(name:)
+              @name = name
+            end
+
+            def as_json(*)
+              {
+                type: TYPE,
+                name: @name
+              }.compact
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/rich_text/rich_text_elements/link.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      class RichText
+        module RichTextElements
+          # https://api.slack.com/reference/block-kit/blocks#element-types
+          class Link
+            include RichTextElements::StyleHelper
+            TYPE = 'link'
+            VALID_STYLES = %w[bold italic strike code].freeze
+
+            def initialize(url:, text: nil, unsafe: nil, styles: [])
+              @url = url
+              @text = text
+              @unsafe = unsafe
+              @styles = styles
+              validate_styles(styles, VALID_STYLES)
+            end
+
+            def as_json(*)
+              {
+                type: TYPE,
+                url: @url,
+                text: @text,
+                unsafe: @unsafe,
+                style: styles_as_json(@styles)
+              }.compact
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/rich_text/rich_text_elements/style_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      class RichText
+        module RichTextElements
+          module StyleHelper
+            def validate_styles(provided_styles, valid_styles)
+              provided_styles.each do |style|
+                raise ArgumentError, "Invalid style: #{style}. Valid styles: #{valid_styles}." unless valid_styles.include?(style)
+              end
+            end
+
+            def styles_as_json(styles)
+              return if styles.empty?
+
+              styles.each_with_object({}) { |style, block| block[style] = true }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/rich_text/rich_text_elements/text.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      class RichText
+        module RichTextElements
+          # https://api.slack.com/reference/block-kit/blocks#element-types
+          class Text
+            include RichTextElements::StyleHelper
+            TYPE = 'text'
+            VALID_STYLES = %w[bold italic strike code].freeze
+
+            def initialize(text:, styles: [])
+              @text = text
+              @styles = styles
+              validate_styles(styles, VALID_STYLES)
+            end
+
+            def as_json(*)
+              {
+                type: TYPE,
+                text: @text,
+                style: styles_as_json(@styles)
+              }.compact
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/rich_text/rich_text_elements/user.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      class RichText
+        module RichTextElements
+          # https://api.slack.com/reference/block-kit/blocks#element-types
+          class User
+            include RichTextElements::StyleHelper
+            TYPE = 'user'
+            VALID_STYLES = %w[bold italic strike highlight client_highlight unlink].freeze
+
+            def initialize(user_id:, styles: [])
+              @user_id = user_id
+              @styles = styles
+              validate_styles(styles, VALID_STYLES)
+            end
+
+            def as_json(*)
+              {
+                type: TYPE,
+                user_id: @user_id,
+                style: styles_as_json(@styles)
+              }.compact
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/rich_text/rich_text_elements/usergroup.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      class RichText
+        module RichTextElements
+          # https://api.slack.com/reference/block-kit/blocks#element-types
+          class Usergroup
+            include RichTextElements::StyleHelper
+            TYPE = 'usergroup'
+            VALID_STYLES = %w[bold italic strike highlight client_highlight unlink].freeze
+
+            def initialize(usergroup_id:, styles: [])
+              @usergroup_id = usergroup_id
+              @styles = styles
+              validate_styles(styles, VALID_STYLES)
+            end
+
+            def as_json(*)
+              {
+                type: TYPE,
+                usergroup_id: @usergroup_id,
+                style: styles_as_json(@styles)
+              }.compact
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/rich_text/rich_text_elements.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      class RichText
+        module RichTextElements
+          # https://api.slack.com/reference/block-kit/blocks#element-types
+          def channel(channel_id:, styles: [])
+            append(RichTextElements::Channel.new(channel_id: channel_id, styles: styles))
+          end
+
+          def emoji(name:)
+            append(RichTextElements::Emoji.new(name: name))
+          end
+
+          def link(url:, text: nil, unsafe: nil, styles: [])
+            append(RichTextElements::Link.new(url: url, text: text, unsafe: unsafe, styles: styles))
+          end
+
+          def text(text:, styles: [])
+            append(RichTextElements::Text.new(text: text, styles: styles))
+          end
+
+          def user(user_id:, styles: [])
+            append(RichTextElements::User.new(user_id: user_id, styles: styles))
+          end
+
+          def usergroup(usergroup_id:, styles: [])
+            append(RichTextElements::Usergroup.new(usergroup_id: usergroup_id, styles: styles))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/rich_text/rich_text_list.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      class RichText
+        # https://api.slack.com/reference/block-kit/blocks#rich_text_list
+        class RichTextList
+          TYPE = 'rich_text_list'
+
+          attr_accessor :style, :elements, :indent, :offset, :border
+
+          def initialize(style:, indent: nil, offset: nil, border: nil)
+            @elements = []
+            @style = style
+            @indent = indent
+            @offset = offset
+            @border = border
+
+            yield(self) if block_given?
+          end
+
+          def rich_text_section
+            element = RichTextSection.new
+
+            yield(element) if block_given?
+
+            append(element)
+          end
+
+          def append(element)
+            @elements << element
+
+            self
+          end
+
+          def as_json(*)
+            {
+              type: TYPE,
+              style: @style,
+              elements: @elements.map(&:as_json),
+              indent: @indent,
+              offset: @offset,
+              border: @border
+            }.compact
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/rich_text/rich_text_preformatted.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      class RichText
+        # https://api.slack.com/reference/block-kit/blocks#rich_text_preformatted
+        class RichTextPreformatted
+          include RichTextElements
+          TYPE = 'rich_text_preformatted'
+
+          attr_accessor :elements, :border
+
+          def initialize(border: nil)
+            @elements = []
+            @border = border
+
+            yield(self) if block_given?
+          end
+
+          def append(element)
+            @elements << element
+
+            self
+          end
+
+          def as_json(*)
+            {
+              type: TYPE,
+              border: @border,
+              elements: @elements.map(&:as_json)
+            }.compact
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/rich_text/rich_text_quote.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      class RichText
+        # https://api.slack.com/reference/block-kit/blocks#rich_text_quote
+        class RichTextQuote
+          include RichTextElements
+          TYPE = 'rich_text_quote'
+
+          attr_accessor :elements, :border
+
+          def initialize(border: nil)
+            @elements = []
+            @border = border
+
+            yield(self) if block_given?
+          end
+
+          def append(element)
+            @elements << element
+
+            self
+          end
+
+          def as_json(*)
+            {
+              type: TYPE,
+              border: @border,
+              elements: @elements.map(&:as_json)
+            }.compact
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/rich_text/rich_text_section.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      class RichText
+        # https://api.slack.com/reference/block-kit/blocks#rich_text_section
+        class RichTextSection
+          include RichTextElements
+          TYPE = 'rich_text_section'
+
+          attr_accessor :elements
+
+          def initialize
+            @elements = []
+
+            yield(self) if block_given?
+          end
+
+          def append(element)
+            @elements << element
+
+            self
+          end
+
+          def as_json(*)
+            {
+              type: TYPE,
+              elements: @elements.map(&:as_json)
+            }.compact
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/rich_text.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      # Displays formatted, structured representation of text.
+      #
+      # It is also the output of the Slack client's WYSIWYG message composer, so all messages sent by end-users will have this
+      # format. Use this block to include user-defined formatted text in your Block Kit payload. While it is possible to format
+      # text with mrkdwn, rich_text is strongly preferred and allows greater flexibility.
+      #
+      # https://api.slack.com/reference/block-kit/blocks#rich_text
+      class RichText
+        TYPE = 'rich_text'
+
+        attr_accessor :elements
+
+        def initialize(block_id: nil)
+          @block_id = block_id
+          @elements = []
+
+          yield(self) if block_given?
+        end
+
+        def rich_text_section
+          element = RichTextSection.new
+
+          yield(element) if block_given?
+
+          append(element)
+        end
+
+        def rich_text_list(style: 'bullet', indent: nil, offset: nil, border: nil)
+          element = RichTextList.new(style: style, indent: indent, offset: offset, border: border)
+
+          yield(element) if block_given?
+
+          append(element)
+        end
+
+        def rich_text_preformatted(border: nil)
+          element = RichTextPreformatted.new(border: border)
+
+          yield(element) if block_given?
+
+          append(element)
+        end
+
+        def rich_text_quote(border: nil)
+          element = RichTextQuote.new(border: border)
+
+          yield(element) if block_given?
+
+          append(element)
+        end
+
+        def append(element)
+          @elements << element
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            elements: @elements.map(&:as_json),
+            block_id: @block_id
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/version.rb

@@ -2,6 +2,6 @@
 
 module Slack
   module BlockKit
-    VERSION = '0.23.0'
+    VERSION = '0.25.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-block-kit
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.25.0
 platform: ruby
 authors:
 - Christian Gregg
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-07 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-description:
+description: 
 email:
 - c_arlt@hotmail.com
 executables: []
@@ -46,6 +46,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/README.md
+- examples/comprehensive_rich_text_blocks.rb
+- examples/config.rb
+- examples/example_helper.rb
+- examples/simple_example.rb
+- examples/simple_rich_text_blocks.rb
 - lib/slack-ruby-block-kit.rb
 - lib/slack/block_kit.rb
 - lib/slack/block_kit/blocks.rb
@@ -85,6 +91,19 @@ files:
 - lib/slack/block_kit/layout/header.rb
 - lib/slack/block_kit/layout/image.rb
 - lib/slack/block_kit/layout/input.rb
+- lib/slack/block_kit/layout/rich_text.rb
+- lib/slack/block_kit/layout/rich_text/rich_text_elements.rb
+- lib/slack/block_kit/layout/rich_text/rich_text_elements/channel.rb
+- lib/slack/block_kit/layout/rich_text/rich_text_elements/emoji.rb
+- lib/slack/block_kit/layout/rich_text/rich_text_elements/link.rb
+- lib/slack/block_kit/layout/rich_text/rich_text_elements/style_helper.rb
+- lib/slack/block_kit/layout/rich_text/rich_text_elements/text.rb
+- lib/slack/block_kit/layout/rich_text/rich_text_elements/user.rb
+- lib/slack/block_kit/layout/rich_text/rich_text_elements/usergroup.rb
+- lib/slack/block_kit/layout/rich_text/rich_text_list.rb
+- lib/slack/block_kit/layout/rich_text/rich_text_preformatted.rb
+- lib/slack/block_kit/layout/rich_text/rich_text_quote.rb
+- lib/slack/block_kit/layout/rich_text/rich_text_section.rb
 - lib/slack/block_kit/layout/section.rb
 - lib/slack/block_kit/layout/section/multi_select_elements.rb
 - lib/slack/block_kit/layout/video.rb
@@ -101,7 +120,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -116,8 +135,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
-signing_key:
+rubygems_version: 3.5.22
+signing_key: 
 specification_version: 4
 summary: A ruby wrapper for Slack's Block Kit
 test_files: []