slack-ruby-block-kit 0.6.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1ce18c84f51fac5942313852cb7f12420a4aa77440e3c360ea05b69da6bfa8c
-  data.tar.gz: b01973fff58d82c84652e9238285463d2b59052ffa4ada98bbf99f45eb789739
+  metadata.gz: ba759b665f6bc72dfb41ad6f501de3ddd00e7047673ac805dddbae20bc6c69fb
+  data.tar.gz: e30ecec2128b9f94f4f5f1d55b1b86b035555d49ef6b27f1abeae22e5b0e63b4
 SHA512:
-  metadata.gz: db52491fa1c4402c393daf83ad402f7f173f243b42ecc06567e33a69a90056f13547836b5dd6c32ef0774310be8f86190aa96e27bddaa243f4545444d5525583
-  data.tar.gz: 3b8644c48e2dcacce01d10a8c9b34eb181096bcb94159194169cc618ac233819cacbd78f58afce0baf03c63c233b98b6e686e0af4403b4dfddd81655e2ac60b1
+  metadata.gz: e7784041e0d6e9b42bbfd8dc02dac3bbff8872ba268571c3b1f022a59b390e59fb637dedefb38894f8ee98234db5fa3fd3c1e03e99a8f4f1cd3befc9130ce368
+  data.tar.gz: 2fd57d0ad2722e86e03e130799af76ec58828b9d701fd9726a68b5bbf6e1ce6da780ea93553d34a4f7423ade363c13463cbc28e02e4b65348ec389901c05420c

data/.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 99
+  reviewers:
+  - CGA1123

data/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+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 ]
+        include:
+          - ruby: 'head'
+            experimental: true
+
+    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

@@ -4,7 +4,7 @@ inherit_from: .rubocop_todo.yml
 AllCops:
   TargetRubyVersion: 2.5.3
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
 Style/AsciiComments:
@@ -23,3 +23,48 @@ Metrics/BlockLength:
     - '**/*.rake'
     - 'spec/**/*.rb'
     - '**/*.gemspec'
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10

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,8 @@ 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'
 
 # Offense count: 4
 Style/Documentation:

data/CHANGELOG.md

@@ -0,0 +1,56 @@
+# 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.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.11.0...HEAD
+[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,4 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in tenios-rb.gemspec
 gemspec

data/Gemfile.lock

@@ -1,56 +1,61 @@
 PATH
   remote: .
   specs:
-    slack-ruby-block-kit (0.6.1)
+    slack-ruby-block-kit (0.11.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
+    ast (2.4.1)
     coderay (1.1.2)
     diff-lcs (1.3)
-    dotenv (2.7.5)
+    dotenv (2.7.6)
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    jaro_winkler (1.5.2)
     method_source (1.0.0)
     multipart-post (2.1.1)
-    parallel (1.13.0)
-    parser (2.6.0.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
+    parallel (1.19.2)
+    parser (2.7.1.5)
+      ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    regexp_parser (1.8.0)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.63.1)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.92.0)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.5.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    rubocop-rspec (1.32.0)
-      rubocop (>= 0.60.0)
-    ruby-progressbar (1.10.0)
-    unicode-display_width (1.4.1)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.7.0)
+      parser (>= 2.7.1.5)
+      strscan (>= 1.0.0)
+    rubocop-rspec (1.43.2)
+      rubocop (~> 0.87)
+    ruby-progressbar (1.10.1)
+    strscan (1.0.3)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby

data/lib/slack/block_kit.rb

@@ -6,12 +6,13 @@ module Slack
     module Element; end
     module Layout; end
 
-    VERSION = '0.6.1'
+    VERSION = '0.11.0'
 
-    Dir[File.join(__dir__, 'block_kit', 'composition', '*.rb')].each { |file| require file }
-    Dir[File.join(__dir__, 'block_kit', 'element', '*.rb')].each { |file| require file }
-    Dir[File.join(__dir__, 'block_kit', 'layout', '*.rb')].each { |file| require file }
-    Dir[File.join(__dir__, 'block_kit', '*.rb')].each { |file| require file }
+    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 +23,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,26 @@ 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
+
         def title(text:, emoji: nil)
           @title = PlainText.new(text: text, emoji: emoji)
 

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

@@ -11,7 +11,7 @@ module Slack
         def initialize(value:, text:, emoji: nil, description: nil, url: nil)
           @text = PlainText.new(text: text, emoji: emoji)
           @value = value
-          @description = PlainText.new(text: description, emoji: emoji) if description
+          @description = description && PlainText.new(text: description, emoji: emoji)
           @url = url
         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