slack-ruby-block-kit 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1ce18c84f51fac5942313852cb7f12420a4aa77440e3c360ea05b69da6bfa8c
-  data.tar.gz: b01973fff58d82c84652e9238285463d2b59052ffa4ada98bbf99f45eb789739
+  metadata.gz: fa3cc74b7d6e5de2e6889ec9fdc8ba02b8678be5731708cb7b5319985d839354
+  data.tar.gz: a261f505882c2662bd1009ff3a020a394154dcfe336439e032e0942085a2df46
 SHA512:
-  metadata.gz: db52491fa1c4402c393daf83ad402f7f173f243b42ecc06567e33a69a90056f13547836b5dd6c32ef0774310be8f86190aa96e27bddaa243f4545444d5525583
-  data.tar.gz: 3b8644c48e2dcacce01d10a8c9b34eb181096bcb94159194169cc618ac233819cacbd78f58afce0baf03c63c233b98b6e686e0af4403b4dfddd81655e2ac60b1
+  metadata.gz: 99d3a21decd19a4cfb54351bf31d2ec36516f2777a010ceae26e21b121f3bf229b8c8df2d7a9cef7598ae8fe2f93e42642321d8d7cd72cccdc8b384a62845da2
+  data.tar.gz: c90b7442867bc51d87d8d1bb2c6a34193bcc6ad3cec7808527955e5bc0b157360ffac521ed58b8bd545fca76c3bf86f4d459e649eb26f0e5a69b10a990aa4076

data/.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: circleci/ruby:2.5.3
+      - image: circleci/ruby:2.7
 
     working_directory: ~/repo
 

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/.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,33 @@ 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

data/Gemfile.lock

@@ -1,56 +1,59 @@
 PATH
   remote: .
   specs:
-    slack-ruby-block-kit (0.6.1)
+    slack-ruby-block-kit (0.7.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)
     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)
+    parallel (1.19.1)
+    parser (2.7.1.3)
       ast (~> 2.4.0)
-    powerpack (0.1.2)
     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.7.1)
+    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.85.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
       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.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-rspec (1.40.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby

data/lib/slack/block_kit.rb

@@ -6,12 +6,12 @@ module Slack
     module Element; end
     module Layout; end
 
-    VERSION = '0.6.1'
+    VERSION = '0.7.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 }
 
     module_function
 

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

@@ -9,6 +9,10 @@ module Slack
       #
       # https://api.slack.com/reference/messaging/composition-objects#confirm
       class ConfirmationDialog
+        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/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/external_select.rb

@@ -28,6 +28,7 @@ module Slack
           @action_id = action_id
           @initial_option = initial
           @min_query_length = min_query_length
+          @confirm = nil
 
           yield(self) if block_given?
         end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # A select menu, just as with a standard HTML <select> tag, creates a drop
+      # down menu with a list of options for a user to choose. The select menu
+      # also includes type-ahead functionality, where a user can type a part or
+      # all of an option string to filter the list.
+      #
+      # This multi-select menu will populate its options with a list of public
+      # channels visible to the current user in the active workspace.
+      #
+      # https://api.slack.com/reference/block-kit/block-elements#channel_multi_select
+      class MultiChannelsSelect
+        TYPE = 'multi_channels_select'
+
+        attr_accessor :confirm
+
+        def initialize(placeholder:, action_id:, initial: nil, emoji: nil, max_selected_items: nil)
+          @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
+          @action_id = action_id
+          @initial_channel = initial
+          @confirm = nil
+          @max_selected_items = max_selected_items
+
+          yield(self) if block_given?
+        end
+
+        def confirmation_dialog
+          @confirm = Composition::ConfirmationDialog.new
+
+          yield(@confirm) if block_given?
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            placeholder: @placeholder.as_json,
+            action_id: @action_id,
+            initial_channel: @initial_channel,
+            confirm: @confirm&.as_json,
+            max_selected_items: @max_selected_items
+          }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # A select menu, just as with a standard HTML <select> tag, creates a drop
+      # down menu with a list of options for a user to choose. The select menu
+      # also includes type-ahead functionality, where a user can type a part or
+      # all of an option string to filter the list.
+      #
+      # This multi-select menu will populate its options with a list of public and
+      # private channels, DMs, and MPIMs visible to the current user in the
+      # active workspace.
+      #
+      # https://api.slack.com/reference/block-kit/block-elements#conversation_multi_select
+      class MultiConversationsSelect
+        TYPE = 'multi_conversations_select'
+
+        attr_accessor :confirm
+
+        def initialize(placeholder:, action_id:, initial: nil, emoji: nil, max_selected_items: nil)
+          @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
+          @action_id = action_id
+          @initial_conversation = initial
+          @confirm = nil
+          @max_selected_items = max_selected_items
+
+          yield(self) if block_given?
+        end
+
+        def confirmation_dialog
+          @confirm = Composition::ConfirmationDialog.new
+
+          yield(@confirm) if block_given?
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            placeholder: @placeholder.as_json,
+            action_id: @action_id,
+            initial_conversation: @initial_conversation,
+            confirm: @confirm&.as_json,
+            max_selected_items: @max_selected_items
+          }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # A select menu, just as with a standard HTML <select> tag, creates a drop
+      # down menu with a list of options for a user to choose. The select menu
+      # also includes type-ahead functionality, where a user can type a part or
+      # all of an option string to filter the list.
+      #
+      # This select menu will load its options from an external data source,
+      # allowing for a dynamic list of options.
+      #
+      # Each time a select menu of this type is opened or the user starts typing
+      # in the typeahead field, we'll send a request to your specified URL. Your
+      # app should return an HTTP 200 OK response, along with an
+      # application/json post body with an object containing either an options
+      # array, or an option_groups array.
+      #
+      # https://api.slack.com/reference/block-kit/block-elements#external_multi_select
+      class MultiExternalSelect
+        TYPE = 'multi_external_select'
+
+        attr_accessor :confirm
+
+        def initialize(placeholder:, action_id:,
+                       initial: nil, min_query_length: nil, emoji: nil, max_selected_items: nil)
+
+          @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
+          @action_id = action_id
+          @initial_option = initial
+          @min_query_length = min_query_length
+          @confirm = nil
+          @max_selected_items = max_selected_items
+
+          yield(self) if block_given?
+        end
+
+        def confirmation_dialog
+          @confirm = Composition::ConfirmationDialog.new
+
+          yield(@confirm) if block_given?
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            placeholder: @placeholder.as_json,
+            action_id: @action_id,
+            initial_option: @initial_option&.as_json,
+            min_query_length: @min_query_length,
+            confirm: @confirm&.as_json,
+            max_selected_items: @max_selected_items
+          }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # A select menu, just as with a standard HTML <select> tag, creates a drop
+      # down menu with a list of options for a user to choose. The select menu
+      # also includes type-ahead functionality, where a user can type a part or
+      # all of an option string to filter the list.
+      #
+      # This is the simplest form of select menu, with a static list of options
+      # passed in when defining the element.
+      #
+      # https://api.slack.com/reference/block-kit/block-elements#static_multi_select
+      class MultiStaticSelect
+        TYPE = 'multi_static_select'
+
+        attr_accessor :confirm, :options, :option_groups, :initial_option
+
+        def initialize(placeholder:, action_id:, emoji: nil, max_selected_items: nil)
+          @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
+          @action_id = action_id
+          @confirm = nil
+          @max_selected_items = max_selected_items
+
+          @options = nil
+          @option_groups = nil
+          @initial_option = nil
+
+          yield(self) if block_given?
+        end
+
+        def confirmation_dialog
+          @confirm = Composition::ConfirmationDialog.new
+
+          yield(@confirm) if block_given?
+
+          self
+        end
+
+        def option(value:, text:, emoji: nil)
+          @options ||= []
+          @options << Composition::Option.new(
+            value: value,
+            text: text,
+            emoji: emoji
+          )
+
+          self
+        end
+
+        def option_group(label:, emoji: nil)
+          option_group = Composition::OptionGroup.new(label: label, emoji: emoji)
+
+          yield(option_group) if block_given?
+
+          @option_groups ||= []
+          @option_groups << option_group
+
+          self
+        end
+
+        def initial(value:, text:, emoji: nil)
+          @initial_option = Composition::Option.new(
+            value: value,
+            text: text,
+            emoji: emoji
+          )
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            placeholder: @placeholder.as_json,
+            action_id: @action_id,
+            options: @options&.map(&:as_json),
+            option_groups: @option_groups&.map(&:as_json),
+            initial_option: @initial_option&.as_json,
+            confirm: @confirm&.as_json,
+            max_selected_items: @max_selected_items
+          }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # A select menu, just as with a standard HTML <select> tag, creates a drop
+      # down menu with a list of options for a user to choose. The select menu
+      # also includes type-ahead functionality, where a user can type a part or
+      # all of an option string to filter the list.
+      #
+      # This multi-select menu will populate its options with a list of Slack users
+      # visible to the current user in the active workspace.
+      #
+      # https://api.slack.com/reference/block-kit/block-elements#users_multi_select
+      class MultiUsersSelect
+        TYPE = 'multi_users_select'
+
+        attr_accessor :confirm
+
+        def initialize(placeholder:, action_id:, initial: nil, emoji: nil, max_selected_items: nil)
+          @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
+          @action_id = action_id
+          @initial_user = initial
+          @confirm = nil
+          @max_selected_items = max_selected_items
+
+          yield(self) if block_given?
+        end
+
+        def confirmation_dialog
+          @confirm = Composition::ConfirmationDialog.new
+
+          yield(@confirm) if block_given?
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            placeholder: @placeholder.as_json,
+            action_id: @action_id,
+            initial_user: @initial_user,
+            confirm: @confirm&.as_json,
+            max_selected_items: @max_selected_items
+          }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -22,6 +22,7 @@ module Slack
         def initialize(action_id:)
           @action_id = action_id
           @options = []
+          @confirm = nil
 
           yield(self) if block_given?
         end

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

@@ -22,7 +22,7 @@ module Slack
           min_length: nil,
           max_length: nil
         )
-          @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji) if placeholder
+          @placeholder = placeholder && Composition::PlainText.new(text: placeholder, emoji: emoji)
           @initial_value = initial_value
           @action_id = action_id
           @multiline = multiline

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

@@ -10,6 +10,7 @@ module Slack
         TYPE = 'context'
 
         attr_accessor :elements
+
         def initialize(block_id: nil)
           @block_id = block_id
           @elements = []

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative './section/multi_select_elements'
+
 module Slack
   module BlockKit
     module Layout
@@ -8,13 +10,19 @@ module Slack
       # with any of the available block elements.
       #
       # https://api.slack.com/reference/messaging/blocks#section
+      # rubocop:disable Metrics/ClassLength
       class Section
+        # rubocop:enable Metrics/ClassLength
+
+        include Section::MultiSelectElements
         TYPE = 'section'
 
         attr_accessor :fields, :text, :accessory
 
         def initialize(block_id: nil)
           @block_id = block_id
+          @fields = nil
+          @accessory = nil
 
           yield(self) if block_given?
         end

data/lib/slack/block_kit/layout/section/multi_select_elements.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      class Section
+        # Helper methods for Multi Select to inject to section
+        module MultiSelectElements
+          def multi_channels_select(placeholder:, action_id:,
+                                    initial: nil, emoji: nil, max_selected_items: nil)
+            element = Element::MultiChannelsSelect.new(
+              placeholder: placeholder,
+              action_id: action_id,
+              initial: initial,
+              emoji: emoji,
+              max_selected_items: max_selected_items
+            )
+
+            yield(element) if block_given?
+
+            accessorise(element)
+          end
+
+          def multi_conversations_select(placeholder:, action_id:,
+                                         initial: nil, emoji: nil, max_selected_items: nil)
+            element = Element::MultiConversationsSelect.new(
+              placeholder: placeholder,
+              action_id: action_id,
+              initial: initial,
+              emoji: emoji,
+              max_selected_items: max_selected_items
+            )
+
+            yield(element) if block_given?
+
+            accessorise(element)
+          end
+
+          def multi_external_select(placeholder:, action_id:,
+                                    initial: nil,
+                                    min_query_length: nil,
+                                    emoji: nil,
+                                    max_selected_items: nil)
+            element = Element::MultiExternalSelect.new(
+              placeholder: placeholder,
+              action_id: action_id,
+              initial: initial,
+              min_query_length: min_query_length,
+              emoji: emoji,
+              max_selected_items: max_selected_items
+            )
+
+            yield(element) if block_given?
+
+            accessorise(element)
+          end
+
+          def multi_static_select(placeholder:, action_id:,
+                                  emoji: nil, max_selected_items: nil)
+            element = Element::MultiStaticSelect.new(
+              placeholder: placeholder,
+              action_id: action_id,
+              emoji: emoji,
+              max_selected_items: max_selected_items
+            )
+
+            yield(element) if block_given?
+
+            accessorise(element)
+          end
+
+          def multi_users_select(placeholder:, action_id:,
+                                 initial: nil,
+                                 emoji: nil,
+                                 max_selected_items: nil)
+            element = Element::MultiUsersSelect.new(
+              placeholder: placeholder,
+              action_id: action_id,
+              emoji: emoji,
+              initial: initial,
+              max_selected_items: max_selected_items
+            )
+
+            yield(element) if block_given?
+
+            accessorise(element)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-block-kit
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Christian Gregg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2020-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -144,6 +144,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -168,6 +169,11 @@ files:
 - lib/slack/block_kit/element/date_picker.rb
 - lib/slack/block_kit/element/external_select.rb
 - lib/slack/block_kit/element/image.rb
+- lib/slack/block_kit/element/multi_channels_select.rb
+- lib/slack/block_kit/element/multi_conversations_select.rb
+- lib/slack/block_kit/element/multi_external_select.rb
+- lib/slack/block_kit/element/multi_static_select.rb
+- lib/slack/block_kit/element/multi_users_select.rb
 - lib/slack/block_kit/element/overflow_menu.rb
 - lib/slack/block_kit/element/plain_text_input.rb
 - lib/slack/block_kit/element/static_select.rb
@@ -178,6 +184,7 @@ files:
 - lib/slack/block_kit/layout/image.rb
 - lib/slack/block_kit/layout/input.rb
 - lib/slack/block_kit/layout/section.rb
+- lib/slack/block_kit/layout/section/multi_select_elements.rb
 - slack-ruby-block-kit.gemspec
 homepage: https://github.com/CGA1123/slack-ruby-block-kit
 licenses: