slack_valid_block_kit 0.1.0

data/lib/slack_valid_block_kit/validator/multi_select_menu.rb

@@ -0,0 +1,104 @@
+module SlackValidBlockKit::Validator
+  module MultiSelectMenu
+    MULTI_STATIC_SELECT_PROPERTIES = %i(type placeholder action_id options option_groups initial_options confirm max_selected_items focus_on_load)
+    MULTI_EXTERNAL_SELECT_PROPERTIES = %i(type placeholder action_id min_query_length initial_options confirm max_selected_items focus_on_load)
+    MULTI_USERS_SELECT_PROPERTIES = %i(type placeholder action_id initial_users confirm max_selected_items focus_on_load)
+    MULTI_CONVERSATIONS_SELECT_PROPERTIES = %i(type placeholder action_id initial_conversations default_to_current_conversation confirm max_selected_items filter focus_on_load)
+    MULTI_CHANNELS_SELECT_PROPERTIES = %i(type placeholder action_id initial_channels confirm max_selected_items focus_on_load)
+
+    def validate_multi_static_select(hash, path, options = nil)
+      validate_for_properties(hash, path, MULTI_STATIC_SELECT_PROPERTIES)
+      validate_for(hash[:type], "#{path}.type", String, true, only: ["multi_static_select"])
+
+      validate_for(hash[:options], "#{path}.options", Array, false, max: 100)
+      options = Array(hash[:options])
+      options.each_with_index do |e, i|
+        validate_option(e, "#{path}.options[#{i}]", { text_type: :text_objects })
+      end
+
+      validate_for(hash[:option_groups], "#{path}.option_groups", Array, false, max: 100)
+      option_groups = Array(hash[:option_groups])
+      option_groups.each_with_index do |e, i|
+        validate_option_group(e, "#{path}.option_groups[#{i}]")
+      end
+
+      if hash[:options].nil? && hash[:option_groups].nil?
+        add_error(path, :require_options_or_option_groups)
+      end
+
+      validate_for_initial_option_of_multi_static_select(hash[:initial_options], "#{path}.initial_options", options: options, option_groups: option_groups)
+
+      validate_common_for_multi_select(hash, path, options)
+    end
+
+    def validate_multi_external_select(hash, path, options = nil)
+      validate_for_properties(hash, path, MULTI_EXTERNAL_SELECT_PROPERTIES)
+      validate_for(hash[:type], "#{path}.type", String, true, only: ["multi_external_select"])
+
+      validate_for(hash[:min_query_length], "#{path}.min_query_length", Integer, false)
+      validate_for(hash[:initial_options], "#{path}.initial_options", Array, false)
+
+      validate_common_for_multi_select(hash, path, options)
+    end
+
+    def validate_multi_users_select(hash, path, options = nil)
+      validate_for_properties(hash, path, MULTI_USERS_SELECT_PROPERTIES)
+      validate_for(hash[:type], "#{path}.type", String, true, only: ["multi_users_select"])
+
+      validate_for(hash[:initial_users], "#{path}.initial_users", :array_of_string, false)
+
+      validate_common_for_multi_select(hash, path, options)
+    end
+
+    def validate_multi_conversations_select(hash, path, options = nil)
+      validate_for_properties(hash, path, MULTI_CONVERSATIONS_SELECT_PROPERTIES)
+      validate_for(hash[:type], "#{path}.type", String, true, only: ["multi_conversations_select"])
+
+      validate_for(hash[:initial_conversations], "#{path}.initial_conversations", :array_of_string, false)
+      validate_for(hash[:default_to_current_conversation], "#{path}.default_to_current_conversation", :bool, false)
+      validate_filter(hash["filter"], "#{path}.filter") unless hash["filter"].nil?
+
+      validate_common_for_multi_select(hash, path, options)
+    end
+
+    def validate_multi_channels_select(hash, path, options = nil)
+      validate_for_properties(hash, path, MULTI_CHANNELS_SELECT_PROPERTIES)
+      validate_for(hash[:type], "#{path}.type", String, true, only: ["multi_channels_select"])
+
+      validate_for(hash[:initial_channels], "#{path}.initial_channels", :array_of_string, false)
+
+      validate_common_for_multi_select(hash, path, options)
+    end
+
+    private def validate_common_for_multi_select(hash, path, options = nil)
+      validate_for_plain_text(hash[:placeholder], "#{path}.placeholder", true, 150)
+
+      validate_for_action_id(hash[:action_id], "#{path}.action_id")
+
+      validate_for(hash[:confirm], "#{path}.confirm", Hash, false)
+      validate_confirmation(hash[:confirm], "#{path}.confirm") unless hash[:confirm].nil?
+      validate_for(hash[:max_selected_items], "#{path}.max_selected_items", Integer, false, min: 1)
+      validate_focus_on_load(hash[:focus_on_load], "#{path}.focus_on_load")
+    end
+
+    private def validate_for_initial_option_of_multi_static_select(obj, path, options:, option_groups:)
+      return if obj.nil?
+
+      if !obj.is_a?(Array)
+        add_error(path, :clazz_type, Array)
+        return
+      end
+
+      if obj.respond_to?(:size) && obj.size == 0
+        add_error(path, :no_item)
+        return
+      end
+
+      candidate_groups = option_groups.map { |v| v[:options] } + [options]
+      used_groups = candidate_groups.select { |g| (obj - g).size == 0 }
+      if used_groups.size == 0
+        add_error(path, :must_be_one_of_the_provided_options)
+      end
+    end
+  end
+end

data/lib/slack_valid_block_kit/validator/select_menu.rb

@@ -0,0 +1,100 @@
+module SlackValidBlockKit::Validator
+  module SelectMenu
+    STATIC_SELECT_PROPERTIES = %i(type placeholder action_id options option_groups initial_options confirm focus_on_load)
+    EXTERNAL_SELECT_PROPERTIES = %i(type placeholder action_id min_query_length initial_options confirm focus_on_load)
+    USERS_SELECT_PROPERTIES = %i(type placeholder action_id initial_user confirm focus_on_load)
+    CONVERSATIONS_SELECT_PROPERTIES = %i(type placeholder action_id initial_conversation default_to_current_conversation confirm response_url_enabled filter focus_on_load)
+    CHANNELS_SELECT_PROPERTIES = %i(type placeholder action_id initial_channel confirm response_url_enabled focus_on_load)
+
+    def validate_static_select(hash, path, options = nil)
+      validate_for_properties(hash, path, STATIC_SELECT_PROPERTIES)
+      validate_for(hash[:type], "#{path}.type", String, true, only: ["static_select"])
+
+      validate_for(hash[:options], "#{path}.options", Array, false, max: 100)
+      options = Array(hash[:options])
+      options.each_with_index do |e, i|
+        validate_option(e, "#{path}.options[#{i}]", { text_type: :text_objects })
+      end
+
+      validate_for(hash[:option_groups], "#{path}.option_groups", Array, false, max: 100)
+      option_groups = Array(hash[:option_groups])
+      option_groups.each_with_index do |e, i|
+        validate_option_group(e, "#{path}.option_groups[#{i}]")
+      end
+
+      if hash[:options].nil? && hash[:option_groups].nil?
+        add_error(path, :require_options_or_option_groups)
+      end
+
+      validate_for_initial_option_of_multi_static_select(hash[:initial_option], "#{path}.initial_option", options: options, option_groups: option_groups)
+
+      validate_common_for_select(hash, path, options)
+    end
+
+    def validate_external_select(hash, path, options = nil)
+      validate_for_properties(hash, path, EXTERNAL_SELECT_PROPERTIES)
+      validate_for(hash[:type], "#{path}.type", String, true, only: ["external_select"])
+
+      validate_for(hash[:min_query_length], "#{path}.min_query_length", Integer, false)
+      validate_for(hash[:initial_options], "#{path}.initial_options", Array, false)
+
+      validate_common_for_select(hash, path, options)
+    end
+
+    def validate_users_select(hash, path, options = nil)
+      validate_for_properties(hash, path, USERS_SELECT_PROPERTIES)
+      validate_for(hash[:type], "#{path}.type", String, true, only: ["users_select"])
+
+      validate_for(hash[:initial_user], "#{path}.initial_user", String, false)
+
+      validate_common_for_select(hash, path, options)
+    end
+
+    def validate_conversations_select(hash, path, options = nil)
+      validate_for_properties(hash, path, CONVERSATIONS_SELECT_PROPERTIES)
+      validate_for(hash[:type], "#{path}.type", String, true, only: ["conversations_select"])
+
+      validate_for(hash[:initial_conversation], "#{path}.initial_conversation", String, false)
+      validate_for(hash[:default_to_current_conversation], "#{path}.default_to_current_conversation", :bool, false)
+      validate_filter(hash["filter"], "#{path}.filter")
+      validate_for(hash[:response_url_enabled], "#{path}.response_url_enabled", :bool, false)
+
+      validate_common_for_select(hash, path, options)
+    end
+
+    def validate_channels_select(hash, path, options = nil)
+      validate_for_properties(hash, path, CHANNELS_SELECT_PROPERTIES)
+      validate_for(hash[:type], "#{path}.type", String, true, only: ["channels_select"])
+
+      validate_for(hash[:initial_channel], "#{path}.initial_channel", String, false)
+      validate_for(hash[:response_url_enabled], "#{path}.response_url_enabled", :bool, false)
+
+      validate_common_for_select(hash, path, options)
+    end
+
+    private def validate_common_for_select(hash, path, options = nil)
+      validate_for_plain_text(hash[:placeholder], "#{path}.placeholder", true, 150)
+
+      validate_for_action_id(hash[:action_id], "#{path}.action_id")
+
+      validate_for(hash[:confirm], "#{path}.confirm", Hash, false) unless hash[:confirm].nil?
+      validate_confirmation(hash[:confirm], "#{path}.confirm")
+      validate_focus_on_load(hash[:focus_on_load], "#{path}.focus_on_load")
+    end
+
+    private def validate_for_initial_option_of_multi_static_select(obj, path, options:, option_groups:)
+      return if obj.nil?
+
+      if !obj.is_a?(Hash)
+        add_error(path, :clazz_type, Hash)
+        return
+      end
+
+      candidate_groups = option_groups.map { |v| v[:options] } + [options]
+      used_groups = candidate_groups.select { |g| ([obj] - g).size == 0 }
+      if used_groups.size == 0
+        add_error(path, :must_be_one_of_the_provided_options)
+      end
+    end
+  end
+end

data/lib/slack_valid_block_kit/validator/surface.rb

@@ -0,0 +1,52 @@
+module SlackValidBlockKit::Validator
+  module Surface
+    MODAL_PROPERTIES = %i(type title blocks close submit private_metadata callback_id clear_on_close notify_on_close external_id)
+    HOME_PROPERTIES = %i(type blocks private_metadata callback_id external_id)
+
+    def validate_modal(hash, path, options = nil)
+      validate_for_properties(hash, path, MODAL_PROPERTIES)
+      validate_for(hash[:type], "#{path}.type", String, true, only: ["modal"])
+      validate_for_plain_text(hash[:title], "#{path}.title", true, 24)
+
+      validate_for(hash[:blocks], "#{path}.blocks", Array, true, max: 100)
+      Array(hash[:blocks]).each_with_index do |e, i|
+        validate(e, "#{path}.blocks[#{i}]", :layout_blocks_for_modal)
+      end
+
+      validate_for_plain_text(hash[:close], "#{path}.close", false, 24)
+      validate_for_plain_text(hash[:submit], "#{path}.submit", false, 24)
+
+      if hash[:submit].nil? && Array(hash[:blocks]).select { |b| b[:type] == "input" }.size > 0
+        add_error(path, :require_submit_with_input)
+      end
+
+      validate_for(hash[:private_metadata], "#{path}.private_metadata", String, false, max: 3000)
+      validate_for(hash[:callback_id], "#{path}.callback_id", String, false, max: 255)
+      validate_for(hash[:clear_on_close], "#{path}.clear_on_close", :bool, false)
+      validate_for(hash[:notify_on_close], "#{path}.notify_on_close", :bool, false)
+      validate_for(hash[:external_id], "#{path}.external_id", String, false)
+    end
+
+    def validate_home(hash, path, options = nil)
+      validate_for_properties(hash, path, HOME_PROPERTIES)
+      validate_for(hash[:type], "#{path}.type", String, true, only: ["home"])
+      validate_for_plain_text(hash[:title], "#{path}.title", true, 24)
+
+      validate_for(hash[:blocks], "#{path}.blocks", Array, true, max: 100)
+      Array(hash[:blocks]).each_with_index do |e, i|
+        validate(e, "#{path}.blocks[#{i}]", :layout_blocks_for_home)
+      end
+
+      validate_for(hash[:private_metadata], "#{path}.private_metadata", String, false, max: 3000)
+      validate_for(hash[:callback_id], "#{path}.callback_id", String, false, max: 255)
+      validate_for(hash[:external_id], "#{path}.external_id", String, false)
+    end
+
+    def validate_blocks(hash, path, options = nil)
+      validate_for(hash[:blocks], "#{path}.blocks", Array, true)
+      Array(hash[:blocks]).each_with_index do |e, i|
+        validate(e, "#{path}.blocks[#{i}]", :layout_blocks_for_message)
+      end
+    end
+  end
+end

data/lib/slack_valid_block_kit/validator/uniq.rb

@@ -0,0 +1,23 @@
+module SlackValidBlockKit::Validator
+  module Uniq
+    def validate_block_id
+      path_by_block_id.each do |block_id, paths|
+        next if paths.size <= 1
+        add_error("block_id", :not_uniq, paths)
+      end
+    end
+
+    def validate_action_id
+      path_by_action_id.each do |action_id, paths|
+        next if paths.size <= 1
+        add_error("action_id", :not_uniq, paths)
+      end
+    end
+
+    def validate_focus_on_load
+      if focus_on_load_by_path.keys.size > 1
+        add_error("focus_on_load", :not_uniq, focus_on_load_by_path.keys)
+      end
+    end
+  end
+end

data/lib/slack_valid_block_kit/validator.rb

@@ -0,0 +1,32 @@
+require "slack_valid_block_kit/validator/base"
+require "slack_valid_block_kit/validator/composition"
+require "slack_valid_block_kit/validator/element"
+require "slack_valid_block_kit/validator/error"
+require "slack_valid_block_kit/validator/layout"
+require "slack_valid_block_kit/validator/multi_select_menu"
+require "slack_valid_block_kit/validator/select_menu"
+require "slack_valid_block_kit/validator/surface"
+require "slack_valid_block_kit/validator/uniq"
+
+module SlackValidBlockKit
+  module Validator
+    class Runner
+      include ::SlackValidBlockKit::Validator::Base
+      include ::SlackValidBlockKit::Validator::Layout
+      include ::SlackValidBlockKit::Validator::Element
+      include ::SlackValidBlockKit::Validator::MultiSelectMenu
+      include ::SlackValidBlockKit::Validator::SelectMenu
+      include ::SlackValidBlockKit::Validator::Composition
+      include ::SlackValidBlockKit::Validator::Surface
+      include ::SlackValidBlockKit::Validator::Uniq
+
+      attr_accessor :errors_by_path, :path_by_block_id, :path_by_action_id, :focus_on_load_by_path
+      def initialize
+        self.errors_by_path = {}
+        self.path_by_block_id = {}
+        self.path_by_action_id = {}
+        self.focus_on_load_by_path = {}
+      end
+    end
+  end
+end

data/lib/slack_valid_block_kit/version.rb

@@ -0,0 +1,3 @@
+module SlackValidBlockKit
+  VERSION = "0.1.0"
+end

data/lib/slack_valid_block_kit.rb

@@ -0,0 +1,73 @@
+require "slack_valid_block_kit/version"
+
+require "slack_valid_block_kit/config"
+
+require "slack_valid_block_kit/validator"
+require "slack_valid_block_kit/builder"
+
+module SlackValidBlockKit
+  def self.build(validate: nil)
+    hash = yield(::SlackValidBlockKit::Builder::Runner.new)
+    raise "SlackValidBlockKit.build must return a Hash object." unless hash.is_a?(Hash)
+
+    if validate.nil?
+      if SlackValidBlockKit::Config.skip_validation.nil? || !SlackValidBlockKit::Config.skip_validation
+        validate!(hash)
+      end
+    elsif validate
+      validate!(hash)
+    end
+    hash
+  end
+
+  def self.blocks(validate: nil)
+    blocks = yield(::SlackValidBlockKit::Builder::Runner.new)
+    raise "SlackValidBlockKit.blocks must return an Array object." unless blocks.is_a?(Array)
+
+    if validate.nil?
+      if SlackValidBlockKit::Config.skip_validation.nil? || !SlackValidBlockKit::Config.skip_validation
+        validate_blocks!(blocks)
+      end
+    elsif validate
+      validate_blocks!(blocks)
+    end
+    blocks
+  end
+
+  def self.validate(obj)
+    this = ::SlackValidBlockKit::Validator::Runner.new
+    this.validate(obj, "root", :top)
+    this.validate_block_id
+    this.validate_action_id
+    this.validate_focus_on_load
+    this.errors_by_path
+  end
+
+  def self.validate!(obj)
+    errors_by_path = validate(obj)
+    if errors_by_path.size > 0
+      raise "invalid json.\n#{::SlackValidBlockKit::Validator::Error.messages(errors_by_path).join("\n")}"
+    end
+    true
+  end
+
+  def self.validate_blocks(obj)
+    if obj.is_a?(Array)
+      obj = { blocks: obj }
+    end
+    this = ::SlackValidBlockKit::Validator::Runner.new
+    this.validate_blocks(obj, "root", :top)
+    this.validate_block_id
+    this.validate_action_id
+    this.validate_focus_on_load
+    this.errors_by_path
+  end
+
+  def self.validate_blocks!(blocks)
+    errors_by_path = validate_blocks(blocks)
+    if errors_by_path.size > 0
+      raise "invalid json.\n#{::SlackValidBlockKit::Validator::Error.messages(errors_by_path).join("\n")}"
+    end
+    true
+  end
+end

data/slack_valid_block_kit.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "slack_valid_block_kit/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "slack_valid_block_kit"
+  spec.version       = SlackValidBlockKit::VERSION
+  spec.authors       = ["masayuki-ioki"]
+  spec.email         = ["kikainekox@gmail.com"]
+
+  spec.summary       = %q{A tool for building slack block kit with validation.}
+  spec.description   = %q{A tool for building slack block kit with validation.}
+  spec.homepage      = "https://github.com/kikaineko/slack_valid_block_kit"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: slack_valid_block_kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- masayuki-ioki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A tool for building slack block kit with validation.
+email:
+- kikainekox@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slack_valid_block_kit.rb
+- lib/slack_valid_block_kit/builder.rb
+- lib/slack_valid_block_kit/builder/compositions.rb
+- lib/slack_valid_block_kit/builder/elements.rb
+- lib/slack_valid_block_kit/builder/layouts.rb
+- lib/slack_valid_block_kit/builder/method_generator.rb
+- lib/slack_valid_block_kit/builder/surfaces.rb
+- lib/slack_valid_block_kit/config.rb
+- lib/slack_valid_block_kit/validator.rb
+- lib/slack_valid_block_kit/validator/base.rb
+- lib/slack_valid_block_kit/validator/composition.rb
+- lib/slack_valid_block_kit/validator/element.rb
+- lib/slack_valid_block_kit/validator/error.rb
+- lib/slack_valid_block_kit/validator/layout.rb
+- lib/slack_valid_block_kit/validator/multi_select_menu.rb
+- lib/slack_valid_block_kit/validator/select_menu.rb
+- lib/slack_valid_block_kit/validator/surface.rb
+- lib/slack_valid_block_kit/validator/uniq.rb
+- lib/slack_valid_block_kit/version.rb
+- slack_valid_block_kit.gemspec
+homepage: https://github.com/kikaineko/slack_valid_block_kit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: A tool for building slack block kit with validation.
+test_files: []