slack-ruby-block-kit 0.7.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa3cc74b7d6e5de2e6889ec9fdc8ba02b8678be5731708cb7b5319985d839354
-  data.tar.gz: a261f505882c2662bd1009ff3a020a394154dcfe336439e032e0942085a2df46
+  metadata.gz: 7f687b2454f80feed6080ab0fd166e64cf49a00508d9b9982a661ecd86119d0b
+  data.tar.gz: 2a96434b288cfd05db43a7d29dfc91d547bdca30f55a00d5a82837756a6c8fec
 SHA512:
-  metadata.gz: 99d3a21decd19a4cfb54351bf31d2ec36516f2777a010ceae26e21b121f3bf229b8c8df2d7a9cef7598ae8fe2f93e42642321d8d7cd72cccdc8b384a62845da2
-  data.tar.gz: c90b7442867bc51d87d8d1bb2c6a34193bcc6ad3cec7808527955e5bc0b157360ffac521ed58b8bd545fca76c3bf86f4d459e649eb26f0e5a69b10a990aa4076
+  metadata.gz: 4af8e9ce974a3324d7df340fe21e85a5ec4018b67e9dd8744ea8b1d9537017ef3a21e02db60deb43e19270c7310e1a4ff27d742dba39067811a49381b5a08d77
+  data.tar.gz: d66f7d4e796172ea73938b589f6e26f46e78ab106c1c94d6d323498c9f483df1e26a5d98af15da6b35ef51d2ea00ba9fea64e65344898530665a839e1af0259a

data/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: Test & Lint
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.7' ]
+        experimental: [ false ]
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: gem install bundler:2.1.4
+      - run: bundle install
+      - run: bundle exec rubocop
+      - run: bundle exec rspec --format progress

data/.rubocop.yml

@@ -3,6 +3,7 @@ inherit_from: .rubocop_todo.yml
 
 AllCops:
   TargetRubyVersion: 2.5.3
+  NewCops: enable
 
 Layout/LineLength:
   Max: 120
@@ -53,3 +54,21 @@ Style/HashTransformValues:
 
 Style/SlicingWithRange:
   Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
+RSpec/NestedGroups:
+  Max: 4

data/.rubocop_todo.yml

@@ -17,6 +17,12 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 117
 
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/slack/block_kit/element/multi_static_select.rb'
+
 # Offense count: 5
 # Configuration parameters: Max.
 RSpec/ExampleLength:
@@ -24,6 +30,10 @@ RSpec/ExampleLength:
     - 'spec/lib/slack/block_kit/composition/confirmation_dialog_spec.rb'
     - 'spec/lib/slack/block_kit/composition/option_group_spec.rb'
     - 'spec/lib/slack/block_kit/composition/option_spec.rb'
+    - 'spec/lib/slack/block_kit/element/checkboxes_spec.rb'
+    - 'spec/lib/slack/block_kit/element/radio_buttons_spec.rb'
+    - 'spec/lib/slack/block_kit/composition/option_spec.rb'
+    - 'spec/lib/slack/block_kit/element/multi_static_select_spec.rb'
 
 # Offense count: 4
 Style/Documentation:

data/CHANGELOG.md

@@ -0,0 +1,79 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- N/A
+
+### Changed
+- N/A
+
+### Deprecated
+- N/A
+
+### Removed
+- N/A
+
+### Fixed
+- N/A
+
+### Security
+- N/A
+
+
+---
+
+
+## [0.12.0] - 2020-10-06
+
+### Added
+- `Slack::BlockKit::Layout::Header` (#57)
+
+### Removed
+- `Slack::BlockKit::Element::Checkboxes#initial`, use the `initial:` keyword on `#option`
+- `Slack::BlockKit::Element::MultiStaticSelect#initial`, use the `initial:` keyword on `#option`
+- `Slack::BlockKit::Element::StaticSelect#initial`, use the `initial:` keyword on `#option`
+
+
+---
+
+
+## [0.11.0] - 2020-10-03
+
+### Added
+- Add `Slack::BlockKit::Element::RadioButtons` (#52 by @caalberts)
+
+### Changed
+- Internal refactoring of `#confirmation_dialog` methods into a shared `Confirmable` module. (#48)
+
+### Fixed
+- Ruby2.7 kwarg deprecation warnings
+
+
+---
+
+
+## [0.10.0] - 2020-09-11
+
+### Added
+- Add `Slack::BlockKit::Element::Checkboxes` (#44 by @caalberts)
+
+### Fixed
+- Fixed initial options in multi select blocks (#46 by @caalberts)
+
+
+---
+
+See [releases] for previous changes.
+
+
+[Unreleased]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.12.0...HEAD
+[0.12.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.11.0...v0.12.0
+[0.11.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.10.0...v0.11.0
+[0.10.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.9.0...v0.10.0
+
+[releases]: https://github.com/CGA1123/slack-ruby-block-kit/releases

data/Gemfile

@@ -2,5 +2,7 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in tenios-rb.gemspec
 gemspec
+
+gem 'codecov', require: false
+gem 'simplecov', require: false

data/Gemfile.lock

@@ -1,28 +1,33 @@
 PATH
   remote: .
   specs:
-    slack-ruby-block-kit (0.7.0)
+    slack-ruby-block-kit (0.12.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.1)
+    codecov (0.2.11)
+      json
+      simplecov
     coderay (1.1.2)
     diff-lcs (1.3)
-    dotenv (2.7.5)
+    docile (1.3.2)
+    dotenv (2.7.6)
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
+    json (2.3.1)
     method_source (1.0.0)
     multipart-post (2.1.1)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.1)
+    regexp_parser (1.8.1)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -39,20 +44,24 @@ GEM
     rspec-support (3.9.3)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.85.1)
+    rubocop (0.93.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.0.3)
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
-    rubocop-rspec (1.40.0)
-      rubocop (>= 0.68.1)
+    rubocop-ast (0.7.1)
+      parser (>= 2.7.1.5)
+    rubocop-rspec (1.43.2)
+      rubocop (~> 0.87)
     ruby-progressbar (1.10.1)
+    simplecov (0.19.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
     unicode-display_width (1.7.0)
 
 PLATFORMS
@@ -60,6 +69,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
+  codecov
   dotenv
   faraday
   pry
@@ -68,6 +78,7 @@ DEPENDENCIES
   rspec_junit_formatter
   rubocop
   rubocop-rspec
+  simplecov
   slack-ruby-block-kit!
 
 BUNDLED WITH

data/README.md

@@ -1,5 +1,5 @@
-[![CircleCI](https://circleci.com/gh/CGA1123/slack-ruby-block-kit/tree/master.svg?style=svg)](https://circleci.com/gh/CGA1123/slack-ruby-block-kit/tree/master)
 [![Gem Version](https://badge.fury.io/rb/slack-ruby-block-kit.svg)](https://badge.fury.io/rb/slack-ruby-block-kit)
+[![codecov](https://codecov.io/gh/CGA1123/slack-ruby-block-kit/branch/master/graph/badge.svg)](https://codecov.io/gh/CGA1123/slack-ruby-block-kit)
 
 # Slack::BlockKit
 

data/lib/slack/block_kit.rb

@@ -6,12 +6,11 @@ module Slack
     module Element; end
     module Layout; end
 
-    VERSION = '0.7.0'
-
     Dir[File.join(__dir__, 'block_kit', 'composition', '*.rb')].sort.each { |file| require file }
     Dir[File.join(__dir__, 'block_kit', 'element', '*.rb')].sort.each { |file| require file }
     Dir[File.join(__dir__, 'block_kit', 'layout', '*.rb')].sort.each { |file| require file }
     Dir[File.join(__dir__, 'block_kit', '*.rb')].sort.each { |file| require file }
+    Dir[File.join(__dir__, 'surfaces', '*.rb')].sort.each { |file| require file }
 
     module_function
 
@@ -22,5 +21,48 @@ module Slack
 
       blocks
     end
+
+    def home(blocks: nil,
+             private_metadata: nil, callback_id: nil, external_id: nil)
+      home_surface = Slack::Surfaces::Home.new(blocks: blocks,
+                                               private_metadata: private_metadata,
+                                               callback_id: callback_id,
+                                               external_id: external_id)
+
+      yield(home_surface) if block_given?
+
+      home_surface
+    end
+
+    def modal(title: nil,
+              blocks: nil,
+              private_metadata: nil, callback_id: nil, external_id: nil,
+              clear_on_close: nil, notify_on_close: nil)
+      modal_surface = Slack::Surfaces::Modal.new(title: title,
+                                                 blocks: blocks,
+                                                 private_metadata: private_metadata,
+                                                 callback_id: callback_id,
+                                                 external_id: external_id,
+                                                 clear_on_close: clear_on_close,
+                                                 notify_on_close: notify_on_close)
+
+      yield(modal_surface) if block_given?
+
+      modal_surface
+    end
+
+    def message(blocks: nil, channel: nil, thread_ts: nil, as_user: nil, text: nil)
+      message_surface = Slack::Surfaces::Message.new(
+        blocks: blocks,
+        channel: channel,
+        thread_ts: thread_ts,
+        text: text,
+        as_user: as_user
+      )
+
+      yield(message_surface) if block_given?
+
+      message_surface
+    end
   end
 end

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

@@ -9,6 +9,22 @@ module Slack
       #
       # https://api.slack.com/reference/messaging/composition-objects#confirm
       class ConfirmationDialog
+        # {Confirmable} contains the common behaviour for configuring a
+        # {ConfirmationDialog}
+        module Confirmable
+          def self.included(klass)
+            klass.attr_accessor :confirm
+          end
+
+          def confirmation_dialog
+            self.confirm = Composition::ConfirmationDialog.new
+
+            yield(confirm) if block_given?
+
+            self
+          end
+        end
+
         def initialize
           @title, @confirm, @text, @style = nil
         end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Composition
+      # Provides a way to filter the list of options in a conversations select menu
+      # or conversations multi-select menu.
+      #
+      # @param [Array] only - "include" field
+      #
+      # https://api.slack.com/reference/block-kit/composition-objects#filter_conversations
+      # https://api.slack.com/reference/block-kit/block-elements#conversation_multi_select
+      # https://api.slack.com/reference/block-kit/block-elements#conversation_select
+      class ConversationFilter
+        def initialize(only: nil,
+                       exclude_external_shared_channels: nil,
+                       exclude_bot_users: nil)
+          @only = only
+          @exclude_external_shared_channels = exclude_external_shared_channels
+          @exclude_bot_users = exclude_bot_users
+        end
+
+        def as_json(*)
+          {
+            include: @only,
+            exclude_external_shared_channels: @exclude_external_shared_channels,
+            exclude_bot_users: @exclude_bot_users
+          }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -8,11 +8,16 @@ module Slack
       # https://api.slack.com/reference/messaging/composition-objects#option
       # https://api.slack.com/reference/messaging/block-elements#select
       class Option
-        def initialize(value:, text:, emoji: nil, description: nil, url: nil)
+        def initialize(value:, text:, initial: false, emoji: nil, description: nil, url: nil)
           @text = PlainText.new(text: text, emoji: emoji)
           @value = value
           @description = description && PlainText.new(text: description, emoji: emoji)
           @url = url
+          @initial = initial
+        end
+
+        def initial?
+          !!@initial
         end
 
         def as_json(*)

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)
-          @options << Option.new(text: text, value: value, emoji: emoji)
+        def option(text:, value:, emoji: nil, initial: false)
+          @options << Option.new(text: text, value: value, emoji: emoji, initial: initial)
 
           self
         end

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

@@ -9,9 +9,9 @@ module Slack
       #
       # https://api.slack.com/reference/messaging/block-elements#button
       class Button
-        TYPE = 'button'
+        include Composition::ConfirmationDialog::Confirmable
 
-        attr_accessor :confirm
+        TYPE = 'button'
 
         def initialize(text:, action_id:, style: nil, emoji: nil, url: nil, value: nil)
           @text = Composition::PlainText.new(text: text, emoji: emoji)
@@ -23,14 +23,6 @@ module Slack
           yield(self) if block_given?
         end
 
-        def confirmation_dialog
-          @confirm = Composition::ConfirmationDialog.new
-
-          yield(@confirm) if block_given?
-
-          @confirm
-        end
-
         def as_json(*)
           {
             type: TYPE,
@@ -39,7 +31,7 @@ module Slack
             url: @url,
             value: @value,
             style: @style,
-            confirm: @confirm&.as_json
+            confirm: confirm&.as_json
           }.compact
         end
       end