block-kit 1.0.0

data/lib/block_kit/concerns/has_placeholder.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Concerns
+    module HasPlaceholder
+      MAX_TEXT_LENGTH = 150
+
+      extend ActiveSupport::Concern
+
+      included do
+        plain_text_attribute :placeholder
+        validates :placeholder, presence: true, length: {maximum: MAX_TEXT_LENGTH}, allow_nil: true
+        fixes :placeholder, truncate: {maximum: MAX_TEXT_LENGTH}, null_value: {error_types: [:blank]}
+      end
+
+      def as_json(*)
+        super.merge(placeholder: placeholder&.as_json).compact
+      end
+    end
+  end
+end

data/lib/block_kit/concerns/has_rich_text_elements.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Concerns
+    module HasRichTextElements
+      extend ActiveSupport::Concern
+
+      included do
+        attribute :elements, Types::Array.of(Types::Blocks.new(*Layout::RichText::Elements.all))
+        validates :elements, presence: true, "block_kit/validators/associated": true
+        fixes :elements, associated: true
+
+        dsl_method :elements, as: :broadcast, type: Layout::RichText::Elements::Broadcast, required_fields: [:range], yields: false
+        dsl_method :elements, as: :color, type: Layout::RichText::Elements::Color, required_fields: [:value], yields: false
+        dsl_method :elements, as: :date, type: Layout::RichText::Elements::Date, required_fields: [:timestamp, :format], yields: false
+        dsl_method :elements, as: :emoji, type: Layout::RichText::Elements::Emoji, required_fields: [:name], yields: false
+      end
+
+      def initialize(attributes = {})
+        attributes = attributes.with_indifferent_access
+        attributes[:elements] ||= []
+
+        super
+      end
+
+      def channel(channel_id:, styles: [])
+        style = if styles.present?
+          styles = Array(styles).map { |s| [s.to_s, true] }.to_h
+          Layout::RichText::Elements::MentionStyle.new(**styles.slice(*Layout::RichText::Elements::MentionStyle.attribute_names))
+        end
+
+        append(Layout::RichText::Elements::Channel.new(channel_id: channel_id, style: style))
+      end
+
+      def link(url:, text:, unsafe: nil, styles: [])
+        style = if styles.present?
+          styles = Array(styles).map { |s| [s.to_s, true] }.to_h
+          Layout::RichText::Elements::TextStyle.new(**styles.slice(*Layout::RichText::Elements::TextStyle.attribute_names))
+        end
+
+        append(Layout::RichText::Elements::Link.new(url: url, text: text, unsafe: unsafe, style: style))
+      end
+
+      def text(text:, styles: [])
+        style = if styles.present?
+          styles = Array(styles).map { |s| [s.to_s, true] }.to_h
+          Layout::RichText::Elements::TextStyle.new(**styles.slice(*Layout::RichText::Elements::TextStyle.attribute_names))
+        end
+
+        append(Layout::RichText::Elements::Text.new(text: text, style: style))
+      end
+
+      def usergroup(usergroup_id:, styles: [])
+        style = if styles.present?
+          styles = Array(styles).map { |s| [s.to_s, true] }.to_h
+          Layout::RichText::Elements::MentionStyle.new(**styles.slice(*Layout::RichText::Elements::MentionStyle.attribute_names))
+        end
+
+        append(Layout::RichText::Elements::Usergroup.new(usergroup_id: usergroup_id, style: style))
+      end
+      alias_method :user_group, :usergroup
+
+      def user(user_id:, styles: [])
+        style = if styles.present?
+          styles = Array(styles).map { |s| [s.to_s, true] }.to_h
+          Layout::RichText::Elements::MentionStyle.new(**styles.slice(*Layout::RichText::Elements::MentionStyle.attribute_names))
+        end
+
+        append(Layout::RichText::Elements::User.new(user_id: user_id, style: style))
+      end
+
+      def append(element)
+        elements << element
+
+        self
+      end
+
+      def as_json(*)
+        super.merge(elements: elements&.map(&:as_json)).compact
+      end
+    end
+  end
+end

data/lib/block_kit/concerns/plain_text_emoji_assignment.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Concerns
+    module PlainTextEmojiAssignment
+      def self.new(*attributes)
+        Module.new do
+          define_method(:initialize) do |attrs = {}|
+            raise ArgumentError, "expected `attributes' to be a Hash, got #{attrs.class}" unless attrs.is_a?(Hash)
+
+            emoji = attrs.delete(:emoji)
+
+            super(attrs)
+
+            unless emoji.nil?
+              attributes.each do |attribute|
+                text = public_send(attribute)
+                public_send(:"#{attribute}=", Composition::PlainText.new) if text.nil?
+                public_send(attribute).emoji = emoji
+              end
+            end
+          end
+
+          attributes.each do |attribute|
+            define_method(:"#{attribute}=") do |value|
+              # Attempt to preserve the existing text object's emoji attribute if present
+              text = public_send(attribute)
+              if !text&.emoji.nil? && value.is_a?(String)
+                value = Composition::PlainText.new(text: value, emoji: text.emoji)
+              end
+
+              super(value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/block_kit/concerns.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Concerns
+    autoload :Confirmable, "block_kit/concerns/confirmable"
+    autoload :ConversationSelection, "block_kit/concerns/conversation_selection"
+    autoload :Dispatchable, "block_kit/concerns/dispatchable"
+    autoload :External, "block_kit/concerns/external"
+    autoload :FocusableOnLoad, "block_kit/concerns/focusable_on_load"
+    autoload :HasInitialOption, "block_kit/concerns/has_initial_option"
+    autoload :HasInitialOptions, "block_kit/concerns/has_initial_options"
+    autoload :HasOptions, "block_kit/concerns/has_options"
+    autoload :HasOptionGroups, "block_kit/concerns/has_option_groups"
+    autoload :HasPlaceholder, "block_kit/concerns/has_placeholder"
+    autoload :HasRichTextElements, "block_kit/concerns/has_rich_text_elements"
+    autoload :PlainTextEmojiAssignment, "block_kit/concerns/plain_text_emoji_assignment"
+  end
+end

data/lib/block_kit/elements/base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Elements
+    class Base < BlockKit::Base
+      MAX_ACTION_ID_LENGTH = 255
+
+      attribute :action_id, :string
+      validates :action_id, presence: true, length: {maximum: MAX_ACTION_ID_LENGTH}, allow_nil: true
+      fixes :action_id, truncate: {maximum: MAX_ACTION_ID_LENGTH, dangerous: true, omission: ""}, null_value: {error_types: [:blank]}
+
+      def initialize(attributes = {})
+        raise NotImplementedError, "#{self.class} is an abstract class and can't be instantiated." if instance_of?(Base)
+
+        super
+      end
+
+      def as_json(*)
+        super.merge(action_id: action_id).compact
+      end
+    end
+  end
+end

data/lib/block_kit/elements/base_button.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Elements
+    class BaseButton < Base
+      self.type = :button
+
+      MAX_TEXT_LENGTH = 75
+      MAX_ACCESSIBILITY_LABEL_LENGTH = 75
+      VALID_STYLES = [
+        PRIMARY = "primary",
+        DANGER = "danger"
+      ].freeze
+
+      plain_text_attribute :text
+      attribute :style, :string
+      attribute :accessibility_label, :string
+
+      include Concerns::PlainTextEmojiAssignment.new(:text)
+
+      validates :text, presence: true, length: {maximum: MAX_TEXT_LENGTH}
+      fixes :text, truncate: {maximum: MAX_TEXT_LENGTH}
+
+      validates :style, presence: true, inclusion: {in: VALID_STYLES}, allow_nil: true
+      fixes :style, null_value: {error_types: [:inclusion]}
+
+      validates :accessibility_label, presence: true, length: {maximum: MAX_ACCESSIBILITY_LABEL_LENGTH}, allow_nil: true
+      fixes :accessibility_label, truncate: {maximum: MAX_ACCESSIBILITY_LABEL_LENGTH}, null_value: {error_types: [:blank]}
+
+      def initialize(attributes = {})
+        raise NotImplementedError, "#{self.class} is an abstract class and can't be instantiated." if instance_of?(BaseButton)
+
+        super
+      end
+
+      def as_json(*)
+        super.merge(
+          text: text&.as_json,
+          style: style,
+          accessibility_label: accessibility_label
+        ).compact
+      end
+    end
+  end
+end

data/lib/block_kit/elements/button.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module BlockKit
+  module Elements
+    class Button < BaseButton
+      MAX_URL_LENGTH = 3000
+      MAX_VALUE_LENGTH = 2000
+
+      include Concerns::Confirmable
+
+      attribute :url, :string
+      attribute :value, :string
+
+      validates :url, presence: true, format: {with: URI::DEFAULT_PARSER.make_regexp, message: "is not a valid URI", allow_blank: true}, length: {maximum: MAX_URL_LENGTH}, allow_nil: true
+      fixes :url, truncate: {maximum: MAX_URL_LENGTH, dangerous: true, omission: ""}, null_value: {error_types: [:blank]}
+
+      validates :value, presence: true, length: {maximum: MAX_VALUE_LENGTH}, allow_nil: true
+      fixes :value, truncate: {maximum: MAX_VALUE_LENGTH, dangerous: true, omission: ""}, null_value: {error_types: [:blank]}
+
+      def as_json(*)
+        super.merge(url: url, value: value).compact
+      end
+    end
+  end
+end

data/lib/block_kit/elements/channels_select.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Elements
+    class ChannelsSelect < Select
+      self.type = :channels_select
+
+      attribute :initial_channel, :string
+      attribute :response_url_enabled, :boolean
+
+      validates :initial_channel, presence: true, allow_nil: true
+      fixes :initial_channel, null_value: {error_types: [:blank]}
+
+      def as_json(*)
+        super.merge(
+          initial_channel: initial_channel,
+          response_url_enabled: response_url_enabled
+        ).compact
+      end
+    end
+  end
+end

data/lib/block_kit/elements/checkboxes.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Elements
+    class Checkboxes < Base
+      self.type = :checkboxes
+
+      include Concerns::Confirmable
+      include Concerns::HasOptions.new(limit: 10)
+      include Concerns::HasInitialOptions
+      include Concerns::FocusableOnLoad
+    end
+  end
+end

data/lib/block_kit/elements/conversations_select.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Elements
+    class ConversationsSelect < Select
+      self.type = :conversations_select
+
+      include Concerns::ConversationSelection
+
+      attribute :initial_conversation, :string
+      attribute :response_url_enabled, :boolean
+
+      validates :initial_conversation, presence: true, allow_nil: true
+      fixes :initial_conversation, null_value: {error_types: [:blank]}
+
+      def as_json(*)
+        super.merge(
+          initial_conversation: initial_conversation,
+          response_url_enabled: response_url_enabled
+        ).compact
+      end
+    end
+  end
+end

data/lib/block_kit/elements/date_picker.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Elements
+    class DatePicker < Base
+      self.type = :datepicker
+
+      include Concerns::Confirmable
+      include Concerns::FocusableOnLoad
+      include Concerns::HasPlaceholder
+      include Concerns::PlainTextEmojiAssignment.new(:placeholder)
+
+      attribute :initial_date, :date
+      validates :initial_date, presence: true, allow_nil: true
+
+      def as_json(*)
+        super.merge(initial_date: initial_date&.iso8601).compact
+      end
+    end
+  end
+end

data/lib/block_kit/elements/datetime_picker.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Elements
+    class DatetimePicker < Base
+      self.type = :datetimepicker
+
+      include Concerns::Confirmable
+      include Concerns::FocusableOnLoad
+
+      attribute :initial_date_time, :datetime
+      validates :initial_date_time, presence: true, allow_nil: true
+
+      alias_attribute :initial_datetime, :initial_date_time
+
+      def as_json(*)
+        super.merge(initial_date_time: initial_date_time&.to_i).compact
+      end
+    end
+  end
+end

data/lib/block_kit/elements/email_text_input.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module BlockKit
+  module Elements
+    class EmailTextInput < Base
+      self.type = :email_text_input
+
+      include Concerns::Dispatchable
+      include Concerns::FocusableOnLoad
+      include Concerns::HasPlaceholder
+      include Concerns::PlainTextEmojiAssignment.new(:placeholder)
+
+      attribute :initial_value, :string
+      validates :initial_value, presence: true, format: {with: URI::MailTo::EMAIL_REGEXP}, allow_nil: true
+      fixes :initial_value, null_value: {error_types: [:blank, :invalid]}
+
+      def as_json(*)
+        super.merge(initial_value: initial_value).compact
+      end
+    end
+  end
+end

data/lib/block_kit/elements/external_select.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Elements
+    class ExternalSelect < Select
+      self.type = :external_select
+
+      include Concerns::External
+
+      attribute :initial_option, Types::Generic.of_type(Composition::Option)
+      validates :initial_option, "block_kit/validators/associated": true, allow_nil: true
+      fixes :initial_option, associated: true
+
+      dsl_method :initial_option, required_fields: [:text, :value], yields: false
+
+      def as_json(*)
+        super.merge(initial_option: initial_option&.as_json).compact
+      end
+    end
+  end
+end

data/lib/block_kit/elements/file_input.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/object/inclusion" # Necessary for `max_files.in?(1..10)`
+
+module BlockKit
+  module Elements
+    class FileInput < Base
+      self.type = :file_input
+
+      VALID_MAX_FILES_RANGE = 1..10
+
+      attribute :filetypes, Types::Set.of(:string)
+      attribute :max_files, :integer
+
+      validates :filetypes, presence: true, allow_nil: true
+      validates :max_files, presence: true, numericality: {in: VALID_MAX_FILES_RANGE, only_integer: true}, allow_nil: true
+      fix :clamp_max_files
+
+      def as_json(*)
+        super.merge(
+          filetypes: filetypes&.to_a,
+          max_files: max_files
+        ).compact
+      end
+
+      private
+
+      def clamp_max_files
+        self.max_files = max_files&.clamp(VALID_MAX_FILES_RANGE)
+      end
+    end
+  end
+end

data/lib/block_kit/elements/image.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module BlockKit
+  module Elements
+    class Image < BlockKit::Base
+      self.type = :image
+
+      MAX_ALT_TEXT_LENGTH = 2000
+      MAX_IMAGE_URL_LENGTH = 3000
+
+      attribute :alt_text, :string
+      attribute :image_url, :string
+      attribute :slack_file, Types::Generic.of_type(Composition::SlackFile)
+
+      validates :alt_text, presence: true, length: {maximum: MAX_ALT_TEXT_LENGTH}
+      fixes :alt_text, truncate: {maximum: MAX_ALT_TEXT_LENGTH}
+
+      validates :image_url, presence: true, length: {maximum: MAX_IMAGE_URL_LENGTH}, format: {with: URI::DEFAULT_PARSER.make_regexp(%w[http https]), message: "is not a valid URI", allow_blank: true}, allow_nil: true
+      fixes :image_url, truncate: {maximum: MAX_IMAGE_URL_LENGTH, dangerous: true, omission: ""}, null_value: {error_types: [:blank]}
+
+      validate :slack_file_or_url_present
+
+      def slack_file(attrs = {})
+        attrs = attrs.with_indifferent_access
+        return super() unless attrs.key?(:id) || attrs.key?(:url)
+
+        raise ArgumentError, "mutually exclusive keywords: :id, :url" if attrs.key?(:id) && attrs.key?(:url)
+
+        self.slack_file = Composition::SlackFile.new(**attrs.slice(:id, :url))
+
+        self
+      end
+
+      def as_json(*)
+        super.merge(
+          alt_text: alt_text,
+          image_url: image_url,
+          slack_file: slack_file&.as_json
+        ).compact
+      end
+
+      private
+
+      def slack_file_or_url_present
+        if (slack_file.nil? && image_url.nil?) || (slack_file.present? && image_url.present?)
+          errors.add(:base, "must have either a slack_file or image_url but not both")
+        end
+      end
+    end
+  end
+end

data/lib/block_kit/elements/multi_channels_select.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Elements
+    class MultiChannelsSelect < MultiSelect
+      self.type = :multi_channels_select
+
+      attribute :initial_channels, Types::Set.of(:string)
+      validate :initial_channels_are_all_present
+      fix :remove_blank_initial_channels
+
+      def as_json(*)
+        super.merge(initial_channels: initial_channels&.to_a).compact
+      end
+
+      private
+
+      def initial_channels_are_all_present
+        if Array(initial_channels).any?(&:blank?)
+          errors.add(:initial_channels, "must not contain blank values")
+        end
+      end
+
+      def remove_blank_initial_channels
+        return unless initial_channels.present?
+
+        initial_channels.reject!(&:blank?)
+      end
+    end
+  end
+end

data/lib/block_kit/elements/multi_conversations_select.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Elements
+    class MultiConversationsSelect < MultiSelect
+      self.type = :multi_conversations_select
+
+      include Concerns::ConversationSelection
+
+      attribute :initial_conversations, Types::Set.of(:string)
+      validate :initial_conversations_are_all_present
+      fix :remove_blank_initial_conversations
+
+      def as_json(*)
+        super.merge(initial_conversations: initial_conversations&.to_a).compact
+      end
+
+      private
+
+      def initial_conversations_are_all_present
+        if Array(initial_conversations).any?(&:blank?)
+          errors.add(:initial_conversations, "must not contain blank values")
+        end
+      end
+
+      def remove_blank_initial_conversations
+        return unless initial_conversations.present?
+
+        initial_conversations.reject!(&:blank?)
+      end
+    end
+  end
+end

data/lib/block_kit/elements/multi_external_select.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Elements
+    class MultiExternalSelect < MultiSelect
+      self.type = :multi_external_select
+
+      include Concerns::External
+
+      attribute :initial_options, Types::Array.of(Composition::Option)
+      validates :initial_options, "block_kit/validators/associated": true, allow_nil: true
+      fixes :initial_options, associated: true
+
+      dsl_method :initial_options, as: :initial_option, required_fields: [:text, :value], yields: false
+
+      def as_json(*)
+        super.merge(initial_options: initial_options&.map(&:as_json)).compact
+      end
+    end
+  end
+end

data/lib/block_kit/elements/multi_select.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Elements
+    class MultiSelect < Select
+      attribute :max_selected_items, :integer
+      validates :max_selected_items, presence: true, numericality: {only_integer: true, greater_than: 0}, allow_nil: true
+      fixes :max_selected_items, null_value: {error_types: [:greater_than]}
+
+      def initialize(attributes = {})
+        raise NotImplementedError, "#{self.class} is an abstract class and can't be instantiated." if instance_of?(MultiSelect)
+
+        super
+      end
+
+      def as_json(*)
+        super.merge(max_selected_items: max_selected_items).compact
+      end
+    end
+  end
+end

data/lib/block_kit/elements/multi_static_select.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Elements
+    class MultiStaticSelect < MultiSelect
+      self.type = :multi_static_select
+
+      include Concerns::HasOptionGroups.new(limit: 100, options_limit: 100)
+      include Concerns::HasInitialOptions
+    end
+  end
+end

data/lib/block_kit/elements/multi_users_select.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Elements
+    class MultiUsersSelect < MultiSelect
+      self.type = :multi_users_select
+
+      attribute :initial_users, Types::Set.of(:string)
+      validate :initial_users_are_all_present
+      fix :remove_blank_initial_users
+
+      def as_json(*)
+        super.merge(initial_users: initial_users&.to_a).compact
+      end
+
+      private
+
+      def initial_users_are_all_present
+        if Array(initial_users).any?(&:blank?)
+          errors.add(:initial_users, "must not contain blank values")
+        end
+      end
+
+      def remove_blank_initial_users
+        return unless initial_users.present?
+
+        initial_users.reject!(&:blank?)
+      end
+    end
+  end
+end