slack-ruby-block-kit 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31d357b44cc9c6e928a1ddc3e469393befde7bcc565416167e76767835551115
-  data.tar.gz: 942fb2311a0e388e7fe4d2fe40a76b2c398583fe06facdac05547b2d3102b6b1
+  metadata.gz: db8635d968932366f6665d3d14a9481c1d98473f07091721dda012d8bb372397
+  data.tar.gz: '0398e6c98ac507fa9b29de814fd003a27032c60b59e58901091346727027ce60'
 SHA512:
-  metadata.gz: 93c87de2988ede207c6950fd00ed7c68a84cb30cefeeeb105ce8309595f7135ef5db5ed3a9fa2ebf02e06b0744c0633ac3cd551ac9d93c43462ca1c8a1cb9d9f
-  data.tar.gz: 591a9b52614a626dccbe11dd1ddbf3ec6114f54f509209643d7e6eeac5a213d2e1262842c345ffab18af86e58fecec90ea7f5372403a2f8a03f36e131b5933dc
+  metadata.gz: d5cb493959983cd2fe0db8a23d6a88709819f515652db1a6fb262be708e6b47dcea8e39f9c2be8b95d7b2d8135eb10f2e63186ed68973454cf988712544c2165
+  data.tar.gz: ad3e5412c2924f4b4ff49df0fc337b56875227f1ffe5b70455a6537694677dd2e10421562fefe0b4635ea01a0a94926514487f4b3b38c5446e2ca72a3a24d6a5

data/.rubocop.yml

@@ -65,3 +65,6 @@ Style/RedundantRegexpCharacterClass:
 
 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,7 @@ 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'
 
 # Offense count: 4
 Style/Documentation:

data/CHANGELOG.md

@@ -0,0 +1,45 @@
+# 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.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.10.0...HEAD
+[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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slack-ruby-block-kit (0.9.0)
+    slack-ruby-block-kit (0.10.0)
 
 GEM
   remote: https://rubygems.org/
@@ -9,7 +9,7 @@ GEM
     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)
     method_source (1.0.0)
@@ -39,19 +39,19 @@ GEM
     rspec-support (3.9.3)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.86.0)
+    rubocop (0.90.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.0.3, < 1.0)
+      rubocop-ast (>= 0.3.0, < 1.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.3.0)
+      parser (>= 2.7.1.4)
+    rubocop-rspec (1.43.2)
+      rubocop (~> 0.87)
     ruby-progressbar (1.10.1)
     unicode-display_width (1.7.0)
 

data/lib/slack/block_kit.rb

@@ -6,7 +6,7 @@ module Slack
     module Element; end
     module Layout; end
 
-    VERSION = '0.9.0'
+    VERSION = '0.10.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 }

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # A checkbox group that allows a user to choose multiple items from
+      # a list of possible options.
+      #
+      # https://api.slack.com/reference/messaging/block-elements#checkboxes
+      class Checkboxes
+        TYPE = 'checkboxes'
+
+        attr_accessor :confirm
+
+        def initialize(action_id:)
+          @action_id = action_id
+          @options = []
+          @initial_options = []
+          @confirm = nil
+
+          yield(self) if block_given?
+        end
+
+        def option(value:, text:, description: nil)
+          @options << Composition::Option.new(
+            value: value,
+            text: text,
+            description: description
+          )
+
+          self
+        end
+
+        def initial(value:, text:, description: nil)
+          @initial_options << Composition::Option.new(
+            value: value,
+            text: text,
+            description: description
+          )
+
+          self
+        end
+
+        def confirmation_dialog
+          @confirm = Composition::ConfirmationDialog.new
+
+          yield(@confirm) if block_given?
+
+          @confirm
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            action_id: @action_id,
+            options: @options.map(&:as_json),
+            initial_options: @initial_options.any? ? @initial_options.map(&:as_json) : nil,
+            confirm: @confirm&.as_json
+          }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -20,7 +20,7 @@ module Slack
         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
+          @initial_channels = initial
           @confirm = nil
           @max_selected_items = max_selected_items
 
@@ -40,7 +40,7 @@ module Slack
             type: TYPE,
             placeholder: @placeholder.as_json,
             action_id: @action_id,
-            initial_channel: @initial_channel,
+            initial_channels: @initial_channels,
             confirm: @confirm&.as_json,
             max_selected_items: @max_selected_items
           }.compact

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

@@ -21,7 +21,7 @@ module Slack
         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
+          @initial_conversations = initial
           @confirm = nil
           @max_selected_items = max_selected_items
           @filter = nil
@@ -54,7 +54,7 @@ module Slack
             type: TYPE,
             placeholder: @placeholder.as_json,
             action_id: @action_id,
-            initial_conversation: @initial_conversation,
+            initial_conversations: @initial_conversations,
             confirm: @confirm&.as_json,
             max_selected_items: @max_selected_items,
             filter: @filter&.as_json

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

@@ -28,7 +28,7 @@ module Slack
 
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
           @action_id = action_id
-          @initial_option = initial
+          @initial_options = initial
           @min_query_length = min_query_length
           @confirm = nil
           @max_selected_items = max_selected_items
@@ -49,7 +49,7 @@ module Slack
             type: TYPE,
             placeholder: @placeholder.as_json,
             action_id: @action_id,
-            initial_option: @initial_option&.as_json,
+            initial_options: @initial_options&.map(&:as_json),
             min_query_length: @min_query_length,
             confirm: @confirm&.as_json,
             max_selected_items: @max_selected_items

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

@@ -15,7 +15,7 @@ module Slack
       class MultiStaticSelect
         TYPE = 'multi_static_select'
 
-        attr_accessor :confirm, :options, :option_groups, :initial_option
+        attr_accessor :confirm, :options, :option_groups, :initial_options
 
         def initialize(placeholder:, action_id:, emoji: nil, max_selected_items: nil)
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
@@ -25,7 +25,7 @@ module Slack
 
           @options = nil
           @option_groups = nil
-          @initial_option = nil
+          @initial_options = nil
 
           yield(self) if block_given?
         end
@@ -61,7 +61,8 @@ module Slack
         end
 
         def initial(value:, text:, emoji: nil)
-          @initial_option = Composition::Option.new(
+          @initial_options ||= []
+          @initial_options << Composition::Option.new(
             value: value,
             text: text,
             emoji: emoji
@@ -77,7 +78,7 @@ module Slack
             action_id: @action_id,
             options: @options&.map(&:as_json),
             option_groups: @option_groups&.map(&:as_json),
-            initial_option: @initial_option&.as_json,
+            initial_options: @initial_options&.map(&:as_json),
             confirm: @confirm&.as_json,
             max_selected_items: @max_selected_items
           }.compact

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

@@ -20,7 +20,7 @@ module Slack
         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
+          @initial_users = initial
           @confirm = nil
           @max_selected_items = max_selected_items
 
@@ -40,7 +40,7 @@ module Slack
             type: TYPE,
             placeholder: @placeholder.as_json,
             action_id: @action_id,
-            initial_user: @initial_user,
+            initial_users: @initial_users,
             confirm: @confirm&.as_json,
             max_selected_items: @max_selected_items
           }.compact

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

@@ -156,6 +156,16 @@ module Slack
           accessorise(element)
         end
 
+        def checkboxes(action_id:)
+          element = Element::Checkboxes.new(
+            action_id: action_id
+          )
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
         def image(url:, alt_text:)
           accessorise(Element::Image.new(image_url: url, alt_text: alt_text))
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-block-kit
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Christian Gregg
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-01 00:00:00.000000000 Z
+date: 2020-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,7 +136,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - c_arlt@hotmail.com
 executables: []
@@ -149,6 +149,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -166,6 +167,7 @@ files:
 - lib/slack/block_kit/composition/plain_text.rb
 - lib/slack/block_kit/element/button.rb
 - lib/slack/block_kit/element/channels_select.rb
+- lib/slack/block_kit/element/checkboxes.rb
 - lib/slack/block_kit/element/conversations_select.rb
 - lib/slack/block_kit/element/date_picker.rb
 - lib/slack/block_kit/element/external_select.rb
@@ -195,7 +197,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -211,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A ruby wrapper for Slack's Block Kit
 test_files: []