block-kit 1.0.0

data/lib/block_kit/layout/file.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Layout
+    class File < Base
+      self.type = :file
+
+      MAX_EXTERNAL_ID_LENGTH = 255
+
+      attribute :external_id, :string
+      validates :external_id, presence: true, length: {maximum: MAX_EXTERNAL_ID_LENGTH}
+      fixes :external_id, truncate: {maximum: MAX_EXTERNAL_ID_LENGTH, dangerous: true}
+
+      def as_json(*)
+        super.merge(external_id: external_id, source: "remote").compact
+      end
+    end
+  end
+end

data/lib/block_kit/layout/header.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Layout
+    class Header < Base
+      self.type = :header
+
+      MAX_LENGTH = 150
+
+      plain_text_attribute :text
+
+      include Concerns::PlainTextEmojiAssignment.new(:text)
+
+      validates :text, presence: true, length: {maximum: MAX_LENGTH}
+      fixes :text, truncate: {maximum: MAX_LENGTH}
+
+      def as_json(*)
+        super.merge(text: text&.as_json)
+      end
+    end
+  end
+end

data/lib/block_kit/layout/image.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module BlockKit
+  module Layout
+    class Image < Base
+      MAX_ALT_TEXT_LENGTH = 2000
+      MAX_IMAGE_URL_LENGTH = 3000
+      MAX_TITLE_LENGTH = 2000
+
+      self.type = :image
+
+      attribute :alt_text, :string
+      attribute :image_url, :string
+      attribute :slack_file, Types::Generic.of_type(Composition::SlackFile)
+      plain_text_attribute :title
+
+      include Concerns::PlainTextEmojiAssignment.new(:title)
+
+      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]}
+
+      validates :title, presence: true, length: {maximum: MAX_TITLE_LENGTH}, allow_nil: true
+      fixes :title, truncate: {maximum: MAX_TITLE_LENGTH}, 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,
+          title: title&.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/layout/input.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Layout
+    class Input < Base
+      self.type = :input
+
+      MAX_LABEL_LENGTH = 2000
+      MAX_HINT_LENGTH = 2000
+      SUPPORTED_ELEMENTS = [
+        Elements::ChannelsSelect,
+        Elements::Checkboxes,
+        Elements::ConversationsSelect,
+        Elements::DatePicker,
+        Elements::DatetimePicker,
+        Elements::EmailTextInput,
+        Elements::ExternalSelect,
+        Elements::FileInput,
+        Elements::MultiChannelsSelect,
+        Elements::MultiConversationsSelect,
+        Elements::MultiExternalSelect,
+        Elements::MultiStaticSelect,
+        Elements::MultiUsersSelect,
+        Elements::NumberInput,
+        Elements::PlainTextInput,
+        Elements::RadioButtons,
+        Elements::RichTextInput,
+        Elements::StaticSelect,
+        Elements::TimePicker,
+        Elements::UsersSelect,
+        Elements::URLTextInput
+      ].freeze
+
+      plain_text_attribute :label
+      attribute :element, Types::Blocks.new(*SUPPORTED_ELEMENTS)
+      attribute :dispatch_action, :boolean
+      plain_text_attribute :hint
+      attribute :optional, :boolean
+
+      include Concerns::PlainTextEmojiAssignment.new(:label, :hint)
+
+      validates :label, presence: true, length: {maximum: MAX_LABEL_LENGTH}
+      fixes :label, truncate: {maximum: MAX_LABEL_LENGTH}
+
+      validates :element, presence: true, "block_kit/validators/associated": true
+      fixes :element, associated: true
+
+      validates :dispatch_action, inclusion: {in: [nil, false], message: "can't be enabled for FileInputs"}, if: ->(input) { input.element.is_a?(Elements::FileInput) }
+      fix :unset_dispatch_action_if_file_input
+
+      validates :hint, presence: true, length: {maximum: MAX_HINT_LENGTH}, allow_nil: true
+      fixes :hint, truncate: {maximum: MAX_HINT_LENGTH}, null_value: {error_types: [:blank]}
+
+      dsl_method :element, as: :channels_select, type: Elements::ChannelsSelect
+      dsl_method :element, as: :checkboxes, type: Elements::Checkboxes
+      dsl_method :element, as: :conversations_select, type: Elements::ConversationsSelect
+      dsl_method :element, as: :datepicker, type: Elements::DatePicker
+      dsl_method :element, as: :datetimepicker, type: Elements::DatetimePicker
+      dsl_method :element, as: :email_text_input, type: Elements::EmailTextInput
+      dsl_method :element, as: :external_select, type: Elements::ExternalSelect
+      dsl_method :element, as: :file_input, type: Elements::FileInput
+      dsl_method :element, as: :multi_channels_select, type: Elements::MultiChannelsSelect
+      dsl_method :element, as: :multi_conversations_select, type: Elements::MultiConversationsSelect
+      dsl_method :element, as: :multi_external_select, type: Elements::MultiExternalSelect
+      dsl_method :element, as: :multi_static_select, type: Elements::MultiStaticSelect, mutually_exclusive_fields: [:options, :option_groups]
+      dsl_method :element, as: :multi_users_select, type: Elements::MultiUsersSelect
+      dsl_method :element, as: :number_input, type: Elements::NumberInput
+      dsl_method :element, as: :plain_text_input, type: Elements::PlainTextInput
+      dsl_method :element, as: :radio_buttons, type: Elements::RadioButtons
+      dsl_method :element, as: :rich_text_input, type: Elements::RichTextInput
+      dsl_method :element, as: :static_select, type: Elements::StaticSelect, mutually_exclusive_fields: [:options, :option_groups]
+      dsl_method :element, as: :timepicker, type: Elements::TimePicker
+      dsl_method :element, as: :users_select, type: Elements::UsersSelect
+      dsl_method :element, as: :url_text_input, type: Elements::URLTextInput
+
+      alias_method :channel_select, :channels_select
+      alias_method :conversation_select, :conversations_select
+      alias_method :date_picker, :datepicker
+      alias_method :datetime_picker, :datetimepicker
+      alias_method :email_input, :email_text_input
+      alias_method :multi_channel_select, :multi_channels_select
+      alias_method :multi_conversation_select, :multi_conversations_select
+      alias_method :multi_user_select, :multi_users_select
+      alias_method :text_input, :plain_text_input
+      alias_method :time_picker, :timepicker
+      alias_method :user_select, :users_select
+
+      def optional?
+        !!optional
+      end
+
+      def required?
+        !optional?
+      end
+
+      def dispatch_action?
+        !!dispatch_action
+      end
+
+      def as_json(*)
+        super.merge(
+          label: label&.as_json,
+          element: element&.as_json,
+          dispatch_action: dispatch_action,
+          hint: hint&.as_json,
+          optional: optional
+        ).compact
+      end
+
+      private
+
+      def unset_dispatch_action_if_file_input
+        if dispatch_action? && element.is_a?(Elements::FileInput)
+          self.dispatch_action = false
+        end
+      end
+    end
+  end
+end

data/lib/block_kit/layout/markdown.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Layout
+    class Markdown < Base
+      self.type = :markdown
+
+      MAX_LENGTH = 12_000
+
+      attribute :text, :string
+      validates :text, presence: true, length: {maximum: MAX_LENGTH}
+      fixes :text, truncate: {maximum: MAX_LENGTH}
+
+      def as_json(*)
+        super.merge(text: text).compact
+      end
+    end
+  end
+end

data/lib/block_kit/layout/rich_text/elements/broadcast.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Layout
+    class RichText::Elements::Broadcast < BlockKit::Base
+      self.type = :broadcast
+
+      VALID_RANGES = [
+        HERE = "here",
+        EVERYONE = "everyone",
+        CHANNEL = "channel"
+      ].freeze
+
+      attribute :range, :string
+      validates :range, presence: true, inclusion: {in: VALID_RANGES}
+
+      def as_json(*)
+        super.merge(range: range).compact
+      end
+    end
+  end
+end

data/lib/block_kit/layout/rich_text/elements/channel.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Layout
+    class RichText::Elements::Channel < BlockKit::Base
+      self.type = :channel
+
+      attribute :channel_id, :string
+      attribute :style, Types::Generic.of_type(RichText::Elements::MentionStyle)
+
+      validates :channel_id, presence: true
+
+      def as_json(*)
+        super.merge(
+          channel_id: channel_id,
+          style: style&.as_json
+        ).compact
+      end
+    end
+  end
+end

data/lib/block_kit/layout/rich_text/elements/color.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Layout
+    class RichText::Elements::Color < BlockKit::Base
+      self.type = :color
+
+      attribute :value, :string
+
+      # Slack accepts both hex codes _and_ extended CSS3 color names. However,
+      # they don't actually validate that the value is a real color; they just
+      # display white if it isn't, while allowing the block itself to be valid.
+      validates :value, presence: true
+
+      def as_json(*)
+        super.merge(value: value).compact
+      end
+    end
+  end
+end

data/lib/block_kit/layout/rich_text/elements/date.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module BlockKit
+  module Layout
+    class RichText::Elements::Date < BlockKit::Base
+      self.type = :date
+
+      attribute :timestamp, :datetime
+      attribute :format, :string
+      attribute :url, :string
+      attribute :fallback, :string
+
+      validates :timestamp, presence: true
+      validates :format, presence: true
+
+      validates :url, presence: true, format: {with: URI::DEFAULT_PARSER.make_regexp, message: "is not a valid URI", allow_blank: true}, allow_nil: true
+      fixes :url, null_value: {error_types: [:blank]}
+
+      validates :fallback, presence: true, allow_nil: true
+      fixes :fallback, null_value: {error_types: [:blank]}
+
+      def as_json(*)
+        super.merge(
+          timestamp: timestamp.to_i,
+          format: format,
+          url: url,
+          fallback: fallback
+        ).compact
+      end
+    end
+  end
+end

data/lib/block_kit/layout/rich_text/elements/emoji.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Layout
+    class RichText::Elements::Emoji < BlockKit::Base
+      self.type = :emoji
+
+      attribute :name, :string
+      attribute :unicode, :string
+
+      validates :name, presence: true
+      validates :unicode, presence: true, format: {with: /\A[0-9a-f-]+\z/}, allow_nil: true
+      fixes :unicode, null_value: {error_types: [:blank]}
+
+      def unicode=(value)
+        super(value&.to_s&.downcase)
+      end
+
+      def as_json(*)
+        super.merge(
+          name: name,
+          unicode: unicode
+        ).compact
+      end
+    end
+  end
+end

data/lib/block_kit/layout/rich_text/elements/link.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module BlockKit
+  module Layout
+    class RichText::Elements::Link < BlockKit::Base
+      self.type = :link
+
+      attribute :url, :string
+      attribute :text, :string
+      attribute :unsafe, :boolean
+      attribute :style, Types::Generic.of_type(RichText::Elements::TextStyle)
+
+      validates :url, presence: true, format: {with: URI::DEFAULT_PARSER.make_regexp, message: "is not a valid URI", allow_blank: true}
+      validates :text, presence: true
+
+      def as_json(*)
+        super.merge(
+          url: url,
+          text: text,
+          unsafe: unsafe,
+          style: style&.as_json
+        ).compact
+      end
+    end
+  end
+end

data/lib/block_kit/layout/rich_text/elements/mention_style.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Layout
+    class RichText::Elements::MentionStyle < BlockKit::Base
+      self.type = :rich_text_element_mention_style
+
+      attribute :bold, :boolean
+      attribute :italic, :boolean
+      attribute :strike, :boolean
+      attribute :highlight, :boolean
+      attribute :client_highlight, :boolean
+      attribute :unlink, :boolean
+
+      def as_json(*)
+        {
+          bold: bold,
+          italic: italic,
+          strike: strike,
+          highlight: highlight,
+          client_highlight: client_highlight,
+          unlink: unlink
+        }.compact
+      end
+    end
+  end
+end

data/lib/block_kit/layout/rich_text/elements/text.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module BlockKit
+  module Layout
+    class RichText::Elements::Text < BlockKit::Base
+      self.type = :text
+
+      attribute :text, :string
+      attribute :style, Types::Generic.of_type(RichText::Elements::TextStyle)
+
+      validates :text, presence: true
+
+      def as_json(*)
+        super.merge(
+          text: text,
+          style: style&.as_json
+        ).compact
+      end
+    end
+  end
+end

data/lib/block_kit/layout/rich_text/elements/text_style.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Layout
+    class RichText::Elements::TextStyle < BlockKit::Base
+      self.type = :rich_text_element_text_style
+
+      attribute :bold, :boolean
+      attribute :italic, :boolean
+      attribute :strike, :boolean
+      attribute :code, :boolean
+
+      def as_json(*)
+        {
+          bold: bold,
+          italic: italic,
+          strike: strike,
+          code: code
+        }.compact
+      end
+    end
+  end
+end

data/lib/block_kit/layout/rich_text/elements/user.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Layout
+    class RichText::Elements::User < BlockKit::Base
+      self.type = :user
+
+      attribute :user_id, :string
+      attribute :style, Types::Generic.of_type(RichText::Elements::MentionStyle)
+
+      validates :user_id, presence: true
+
+      def as_json(*)
+        super.merge(
+          user_id: user_id,
+          style: style&.as_json
+        ).compact
+      end
+    end
+  end
+end

data/lib/block_kit/layout/rich_text/elements/usergroup.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Layout
+    class RichText::Elements::Usergroup < BlockKit::Base
+      self.type = :Usergroup
+
+      attribute :usergroup_id, :string
+      attribute :style, Types::Generic.of_type(RichText::Elements::MentionStyle)
+
+      validates :usergroup_id, presence: true
+
+      def as_json(*)
+        super.merge(
+          usergroup_id: usergroup_id,
+          style: style&.as_json
+        ).compact
+      end
+    end
+  end
+end

data/lib/block_kit/layout/rich_text/elements.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Layout
+    module RichText::Elements
+      autoload :Broadcast, "block_kit/layout/rich_text/elements/broadcast"
+      autoload :Channel, "block_kit/layout/rich_text/elements/channel"
+      autoload :Color, "block_kit/layout/rich_text/elements/color"
+      autoload :Date, "block_kit/layout/rich_text/elements/date"
+      autoload :Emoji, "block_kit/layout/rich_text/elements/emoji"
+      autoload :Link, "block_kit/layout/rich_text/elements/link"
+      autoload :Text, "block_kit/layout/rich_text/elements/text"
+      autoload :User, "block_kit/layout/rich_text/elements/user"
+      autoload :Usergroup, "block_kit/layout/rich_text/elements/usergroup"
+
+      # Utility blocks
+      autoload :MentionStyle, "block_kit/layout/rich_text/elements/mention_style"
+      autoload :TextStyle, "block_kit/layout/rich_text/elements/text_style"
+
+      def self.all
+        @all ||= [
+          Broadcast,
+          Channel,
+          Color,
+          Date,
+          Emoji,
+          Link,
+          Text,
+          User,
+          Usergroup
+        ].freeze
+      end
+    end
+  end
+end

data/lib/block_kit/layout/rich_text/list.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Layout
+    class RichText::List < BlockKit::Base
+      self.type = :rich_text_list
+
+      VALID_STYLES = [
+        BULLET = "bullet",
+        ORDERED = "ordered"
+      ].freeze
+
+      attribute :style, :string
+      attribute :elements, Types::Array.of(RichText::Section)
+      attribute :indent, :integer
+      attribute :offset, :integer
+      attribute :border, :integer
+
+      validates :style, presence: true, inclusion: {in: VALID_STYLES}
+      validates :elements, presence: true, "block_kit/validators/associated": true
+      validates :indent, numericality: {only_integer: true, greater_than_or_equal_to: 0}, allow_nil: true
+      validates :offset, numericality: {only_integer: true, greater_than_or_equal_to: 0}, allow_nil: true
+      validates :border, numericality: {only_integer: true, greater_than_or_equal_to: 0}, allow_nil: true
+
+      fixes :elements, associated: true
+
+      dsl_method :elements, as: :section, type: RichText::Section
+      alias_method :rich_text_section, :section
+
+      def as_json(*)
+        super.merge(
+          style: style,
+          elements: elements&.map(&:as_json),
+          indent: indent,
+          offset: offset,
+          border: border
+        ).compact
+      end
+    end
+  end
+end

data/lib/block_kit/layout/rich_text/preformatted.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Layout
+    class RichText::Preformatted < BlockKit::Base
+      self.type = :rich_text_preformatted
+
+      include Concerns::HasRichTextElements
+
+      attribute :border, :integer
+      validates :border, numericality: {only_integer: true, greater_than_or_equal_to: 0}, allow_nil: true
+      fixes :border, null_value: {error_types: [:greater_than_or_equal_to]}
+
+      def as_json(*)
+        super.merge(border: border).compact
+      end
+    end
+  end
+end

data/lib/block_kit/layout/rich_text/quote.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Layout
+    class RichText::Quote < BlockKit::Base
+      self.type = :rich_text_quote
+
+      include Concerns::HasRichTextElements
+
+      attribute :border, :integer
+      validates :border, numericality: {only_integer: true, greater_than_or_equal_to: 0}, allow_nil: true
+      fixes :border, null_value: {error_types: [:greater_than_or_equal_to]}
+
+      def as_json(*)
+        super.merge(border: border).compact
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BlockKit
+  module Layout
+    class RichText::Section < BlockKit::Base
+      self.type = :rich_text_section
+
+      include Concerns::HasRichTextElements
+    end
+  end
+end