slack-ruby-block-kit 0.8.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba4b59b1f8d591f6560563d913833ea5193d3c0ad1ff46e30b4484949d8cfeda
-  data.tar.gz: 90c8576e1fadb6b9a17d8e6c76f9c871e073fa0cab1e9178a26959b80e62b1fa
+  metadata.gz: 0f8259eb752347ee6abf3210ab4b0f0c44ee962d238e3034185735c4762a8063
+  data.tar.gz: 7649061472dff64eddb8704311ee17afbd0c29d07ac6d101982725fbf55fbd35
 SHA512:
-  metadata.gz: 37e969657c3cd6f54fd0f4d9a77292b4740917463823b84af9325a87455b6b686af353d98769a09d6e36e2ddd503e62fc1d460f981c359326deb87232349d89c
-  data.tar.gz: af06784a17f10737b24c85b3ee2b59dd34f0bd61da21e19234d1cca04e213a195ca5698ec8ddbb876dd3a8fdf5894814b2c39da65305747f78a907401fbf5ccb
+  metadata.gz: d9ab666ea3cca8ca7ade809cb1fc3881e534d5a9ffb1651f2de2d1ddc30266e6d44ac1a89947b1cba62d35ba59e292479ec33e0098fe50d1b6d7a1d1e77a0184
+  data.tar.gz: 709140300213ec4afef7c43665e56dd9ccfe673118284d2cb5efbe5a03c87ee9d42fed94e6c8277cc49ffec74d5232108d1b0555c53dcc7e23cc77f6cc70413d

data/.deepsource.toml

@@ -0,0 +1,15 @@
+version = 1
+
+test_patterns = ["spec/**/*_spec.rb"]
+
+[[analyzers]]
+name = "test-coverage"
+enabled = true
+
+[[analyzers]]
+name = "ruby"
+enabled = true
+
+[[transformers]]
+name = "rubocop"
+enabled = true

data/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: Test & Lint
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+env:
+  DEEPSOURCE_DSN: ${{ secrets.DEEPSOURCE_DSN }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.7', '3.0' ]
+        experimental: [ false ]
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: curl https://deepsource.io/cli | sh
+      - run: gem install bundler:2.1.4
+      - run: bundle install
+      - run: bundle exec rubocop
+      - run: bundle exec rspec --format progress
+      - run: ./bin/deepsource report --analyzer test-coverage --key ruby --value-file ./coverage/.resultset.json
+        if: (github.event_name == 'push') || (github.event.pull_request.head.repo.full_name == github.repository) # don't run on forks which don't have access to DEEPSOURCE_DSN

data/.gitignore

@@ -8,6 +8,8 @@
 /spec/examples.txt
 /tmp/
 
+Gemfile.lock
+
 # rspec failure tracking
 .rspec_status
 *.gem

data/.rubocop.yml

@@ -1,8 +1,12 @@
-require: rubocop-rspec
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
 inherit_from: .rubocop_todo.yml
 
 AllCops:
   TargetRubyVersion: 2.5.3
+  NewCops: enable
 
 Layout/LineLength:
   Max: 120
@@ -53,3 +57,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,93 @@
+# 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.13.0] - 2020-12-29
+
+### Added
+- Ruby3 Support
+- `Slack::BlockKit::Element::Timepicker` (#72)
+- Add `input` to `Slack::BlockKit::Blocks` and elements to `Slack::BlockKit::Layout::Input` (#73)
+
+### Changed
+- Development dependencies now managed by bundler via Gemfile, rather than in gemspec
+
+
+---
+
+
+## [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.13.0...HEAD
+[0.13.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.12.0...v0.13.0
+[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,18 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in tenios-rb.gemspec
 gemspec
+
+gem 'dotenv', '~> 2'
+gem 'faraday', '~> 1'
+gem 'pry', '~> 0.13'
+gem 'rake', '~> 13'
+gem 'rspec', '~> 3'
+gem 'rspec_junit_formatter', '~> 0.4'
+
+gem 'rubocop', '~> 1', require: false
+gem 'rubocop-rake', '~> 0.5', require: false
+gem 'rubocop-rspec', '~> 2', require: false
+
+gem 'codecov', '~> 0.2', require: false
+gem 'simplecov', '~> 0.20', require: false if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3')

data/README.md

@@ -1,5 +1,7 @@
-[![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)
+[![DeepSource](https://deepsource.io/gh/CGA1123/slack-ruby-block-kit.svg/?label=active+issues&show_trend=true)](https://deepsource.io/gh/CGA1123/slack-ruby-block-kit/?ref=repository-badge)
+[![DeepSource](https://deepsource.io/gh/CGA1123/slack-ruby-block-kit.svg/?label=resolved+issues&show_trend=true)](https://deepsource.io/gh/CGA1123/slack-ruby-block-kit/?ref=repository-badge)
 
 # Slack::BlockKit
 

data/lib/slack/block_kit.rb

@@ -3,15 +3,16 @@
 module Slack
   module BlockKit
     module Composition; end
+
     module Element; end
-    module Layout; end
 
-    VERSION = '0.8.0'
+    module Layout; end
 
     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/blocks.rb

@@ -57,6 +57,18 @@ module Slack
         append(block)
       end
 
+      def input(label:, hint: nil, block_id: nil)
+        block = Layout::Input.new(
+          label: label,
+          hint: hint,
+          block_id: block_id
+        )
+
+        yield(block) if block_given?
+
+        append(block)
+      end
+
       def append(block)
         @blocks << block
 

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/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

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

@@ -13,9 +13,9 @@ module Slack
       #
       # https://api.slack.com/reference/messaging/block-elements#channel-select
       class ChannelsSelect
-        TYPE = 'channels_select'
+        include Composition::ConfirmationDialog::Confirmable
 
-        attr_accessor :confirm
+        TYPE = 'channels_select'
 
         def initialize(placeholder:, action_id:, initial: nil, emoji: nil)
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
@@ -25,21 +25,13 @@ module Slack
           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
+            confirm: confirm&.as_json
           }.compact
         end
       end