block-kit 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 033e781b6f1656644ae2038ad1c4d1575f9fe1e9179da732127edb43895612c7
-  data.tar.gz: dbb788025b21764ec964ccfa6c7b2409f47990e64990e62dde1d96ab11e28dd5
+  metadata.gz: 9eb45957df50e7755b070ec1e7167490ab8f9f399699ee5de352552f43b6946f
+  data.tar.gz: bc88817b9ba976aa1e4804d5e42feb85fa6d42fdcc74cd029ff8f2272ebf3c90
 SHA512:
-  metadata.gz: c9fac2d8adf017f7fcdb109ad1c55f011668c5ec3d2e716d895aaaf38e95d46846b8b7c7a78989e7c8cd40f2ec3a05bf3448d9f9332465757bf7ebe512a55caf
-  data.tar.gz: 777df84ebe6aa32be0ff508d52138bda2546fa5ce0ba60a00aa255637ae3274e78f89382a7cb7dbc70cbbbf91dee43fa937477c30e48aa88ead22e7ebe96dce9
+  metadata.gz: f41484044c660930c2c4754fcff3e97e046da19cb14ffd6e4a1af83055e6e5ebcd9d5ca16ec04a538db0e8fc9b22490951ac37f0b27ecbae1401ab3bd0b068de
+  data.tar.gz: fbce285e1a58fb5c91309743fbdff18a01c477d9779e44c07336c62253957cc8a0507316476fa49fffa1696a1187e12cc32e57119df2dfea93ee0c6dddbc9fcf

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.4.4

data/lib/block_kit/base.rb

@@ -141,6 +141,10 @@ module BlockKit
       plain_text_fields = type.block_class.attribute_types.select { |_, v| v.respond_to?(:block_class) && v.block_class == Composition::PlainText }.keys.map(&:to_sym)
 
       define_method(as || attribute) do |args = {}, &block|
+        # Convert any args that were passed as attribute aliases to the actual attribute name while keeping
+        # the original arg names in case we need to reference them in a later error message.
+        attribute_aliases = type.block_class.attribute_aliases
+        args = args.transform_keys { |arg| attribute_aliases[arg.to_s] || arg } if attribute_aliases.any?
         args = args.symbolize_keys
 
         # Return the existing attribute if no args or block are passed and we're not in a custom-named method
@@ -161,6 +165,10 @@ module BlockKit
 
         mutually_exclusive = mutually_exclusive_fields & args.keys
         if mutually_exclusive.length > 1
+          # This is the only error message that might need to show original arg names
+          # based on aliases; missing or unknown fields can't be affected.
+          mutually_exclusive = mutually_exclusive.map { |arg| attribute_aliases.key(arg) || arg }
+
           message = "mutually exclusive keywords: #{mutually_exclusive.map(&:inspect).join(", ")}"
           raise ArgumentError, message
         end

data/lib/block_kit/blocks.rb

@@ -4,7 +4,7 @@ require "active_support/core_ext/module/delegation"
 
 module BlockKit
   class Blocks < Base
-    attribute :blocks, Types::Array.of(Types::Blocks.new(*Layout.all))
+    attribute :blocks, Types::Array.of(Types::Blocks.new(*Layout.all)), default: []
     validates :blocks, "block_kit/validators/associated": true
     fixes :blocks, associated: true
 
@@ -22,8 +22,7 @@ module BlockKit
     delegate_missing_to :blocks
 
     def initialize(attributes = {})
-      attributes = attributes.with_indifferent_access
-      attributes[:blocks] ||= []
+      attributes = {blocks: attributes} if attributes.is_a?(Array)
 
       super
     end

data/lib/block_kit/composition/dispatch_action_config.rb

@@ -10,18 +10,19 @@ module BlockKit
         ON_CHARACTER_ENTERED = "on_character_entered"
       ].freeze
 
-      attribute :trigger_actions_on, Types::Set.of(:string)
+      attribute :trigger_actions_on, Types::Set.of(:string), default: []
       validates :trigger_actions_on, presence: true, "block_kit/validators/array_inclusion": {in: VALID_TRIGGERS}
       fixes :trigger_actions_on, null_value: {error_types: [:inclusion]}
 
+      alias_attribute :triggers, :trigger_actions_on
+
       VALID_TRIGGERS.each do |value|
         define_method(:"trigger_actions_on_#{value}?") do
           !!trigger_actions_on&.member?(value)
         end
 
         define_method(:"trigger_actions_on_#{value}!") do
-          self.trigger_actions_on ||= []
-          self.trigger_actions_on.add(value)
+          trigger_actions_on.add(value)
         end
       end
 
@@ -29,5 +30,7 @@ module BlockKit
         super().except(:type).merge(trigger_actions_on: trigger_actions_on&.to_a).compact
       end
     end
+
+    DispatchActionConfiguration = DispatchActionConfig
   end
 end

data/lib/block_kit/composition/slack_file.rb

@@ -21,7 +21,7 @@ module BlockKit
       validate :id_or_url_present
 
       def as_json(*)
-        super().except(:type).merge(id: id, url: url).compact
+        {id: id, url: url}.compact
       end
 
       private

data/lib/block_kit/composition/trigger.rb

@@ -16,6 +16,10 @@ module BlockKit
       validates :customizable_input_parameters, presence: true, "block_kit/validators/associated": true, allow_nil: true
       fixes :customizable_input_parameters, null_value: {error_types: [:blank]}
 
+      alias_attribute :input_parameters, :customizable_input_parameters
+      alias_attribute :customizable_input_params, :customizable_input_parameters
+      alias_attribute :input_params, :customizable_input_parameters
+
       dsl_method :customizable_input_parameters, as: :customizable_input_parameter, required_fields: [:name, :value], yields: false
 
       alias_method :input_parameter, :customizable_input_parameter

data/lib/block_kit/composition.rb

@@ -5,6 +5,7 @@ module BlockKit
     autoload :ConfirmationDialog, "block_kit/composition/confirmation_dialog"
     autoload :ConversationFilter, "block_kit/composition/conversation_filter"
     autoload :DispatchActionConfig, "block_kit/composition/dispatch_action_config"
+    autoload :DispatchActionConfiguration, "block_kit/composition/dispatch_action_config"
     autoload :InputParameter, "block_kit/composition/input_parameter"
     autoload :Mrkdwn, "block_kit/composition/mrkdwn"
     autoload :OptionGroup, "block_kit/composition/option_group"

data/lib/block_kit/concerns/confirmable.rb

@@ -10,6 +10,8 @@ module BlockKit
         validates :confirm, "block_kit/validators/associated": true, allow_nil: true
         fixes :confirm, associated: true
 
+        alias_attribute :confirmation_dialog, :confirm
+
         dsl_method :confirm, required_fields: [:title, :text, :confirm, :deny], yields: false
       end
 

data/lib/block_kit/concerns/conversation_selection.rb

@@ -9,10 +9,13 @@ module BlockKit
         attribute :default_to_current_conversation, :boolean
         attribute :filter, Types::Generic.of_type(Composition::ConversationFilter)
 
+        alias_attribute :conversation_filter, :filter
+
         validates :filter, "block_kit/validators/associated": true, allow_nil: true
         fixes :filter, associated: true
 
         dsl_method :filter
+        alias_method :conversation_filter, :filter
       end
 
       def as_json(*)

data/lib/block_kit/concerns/dispatchable.rb

@@ -7,13 +7,13 @@ module BlockKit
 
       included do
         attribute :dispatch_action_config, Types::Generic.of_type(Composition::DispatchActionConfig)
+        alias_attribute :dispatch_action_configuration, :dispatch_action_config
 
         validates :dispatch_action_config, presence: true, "block_kit/validators/associated": true, allow_nil: true
         fixes :dispatch_action_config, associated: true
 
         dsl_method :dispatch_action_config
         alias_method :dispatch_action_configuration, :dispatch_action_config
-        alias_attribute :dispatch_action_configuration, :dispatch_action_config
       end
 
       def as_json(*)

data/lib/block_kit/concerns/has_rich_text_elements.rb

@@ -6,7 +6,7 @@ module BlockKit
       extend ActiveSupport::Concern
 
       included do
-        attribute :elements, Types::Array.of(Types::Blocks.new(*Layout::RichText::Elements.all))
+        attribute :elements, Types::Array.of(Types::Blocks.new(*Layout::RichText::Elements.all)), default: []
         validates :elements, presence: true, "block_kit/validators/associated": true
         fixes :elements, associated: true
 
@@ -16,13 +16,6 @@ module BlockKit
         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

data/lib/block_kit/concerns/plain_text_emoji_assignment.rb

@@ -5,12 +5,12 @@ module BlockKit
     module PlainTextEmojiAssignment
       def self.new(*attributes)
         Module.new do
-          define_method(:initialize) do |attrs = {}|
+          define_method(:initialize) do |attrs = {}, &block|
             raise ArgumentError, "expected `attributes' to be a Hash, got #{attrs.class}" unless attrs.is_a?(Hash)
 
             emoji = attrs.delete(:emoji)
 
-            super(attrs)
+            super(attrs, &block)
 
             unless emoji.nil?
               attributes.each do |attribute|

data/lib/block_kit/elements/datetime_picker.rb

@@ -17,5 +17,7 @@ module BlockKit
         super.merge(initial_date_time: initial_date_time&.to_i).compact
       end
     end
+
+    Datetimepicker = DatetimePicker
   end
 end

data/lib/block_kit/elements/image.rb

@@ -14,6 +14,8 @@ module BlockKit
       attribute :image_url, :string
       attribute :slack_file, Types::Generic.of_type(Composition::SlackFile)
 
+      alias_attribute :url, :image_url
+
       validates :alt_text, presence: true, length: {maximum: MAX_ALT_TEXT_LENGTH}
       fixes :alt_text, truncate: {maximum: MAX_ALT_TEXT_LENGTH}
 

data/lib/block_kit/elements/overflow.rb

@@ -9,7 +9,7 @@ module BlockKit
 
       include Concerns::Confirmable
 
-      attribute :options, Types::Array.of(Composition::OverflowOption)
+      attribute :options, Types::Array.of(Composition::OverflowOption), default: []
       validates :options, presence: true, length: {maximum: MAX_OPTIONS, message: "is too long (maximum is %{count} options)"}, "block_kit/validators/associated": true
       fixes :options, truncate: {maximum: MAX_OPTIONS, dangerous: true}, associated: true
 

data/lib/block_kit/elements/time_picker.rb

@@ -39,5 +39,7 @@ module BlockKit
         end
       end
     end
+
+    Timepicker = TimePicker
   end
 end

data/lib/block_kit/elements.rb

@@ -14,6 +14,7 @@ module BlockKit
     autoload :ConversationsSelect, "block_kit/elements/conversations_select"
     autoload :DatePicker, "block_kit/elements/date_picker"
     autoload :DatetimePicker, "block_kit/elements/datetime_picker"
+    autoload :Datetimepicker, "block_kit/elements/datetime_picker"
     autoload :EmailTextInput, "block_kit/elements/email_text_input"
     autoload :ExternalSelect, "block_kit/elements/external_select"
     autoload :FileInput, "block_kit/elements/file_input"
@@ -29,6 +30,7 @@ module BlockKit
     autoload :RichTextInput, "block_kit/elements/rich_text_input"
     autoload :StaticSelect, "block_kit/elements/static_select"
     autoload :TimePicker, "block_kit/elements/time_picker"
+    autoload :Timepicker, "block_kit/elements/time_picker"
     autoload :URLTextInput, "block_kit/elements/url_text_input"
     autoload :UsersSelect, "block_kit/elements/users_select"
     autoload :WorkflowButton, "block_kit/elements/workflow_button"

data/lib/block_kit/layout/actions.rb

@@ -28,14 +28,7 @@ module BlockKit
         Elements::WorkflowButton
       ]
 
-      def initialize(attributes = {})
-        attributes = attributes.with_indifferent_access
-        attributes[:elements] ||= []
-
-        super
-      end
-
-      attribute :elements, Types::Array.of(Types::Blocks.new(*SUPPORTED_ELEMENTS))
+      attribute :elements, Types::Array.of(Types::Blocks.new(*SUPPORTED_ELEMENTS)), default: []
       validates :elements, presence: true, length: {maximum: MAX_ELEMENTS, message: "is too long (maximum is %{count} elements)"}, "block_kit/validators/associated": true
       fixes :elements, truncate: {maximum: MAX_ELEMENTS, dangerous: true}, associated: true
 

data/lib/block_kit/layout/context.rb

@@ -12,20 +12,13 @@ module BlockKit
         Composition::PlainText
       ].freeze
 
-      attribute :elements, Types::Array.of(Types::Blocks.new(*SUPPORTED_ELEMENTS))
+      attribute :elements, Types::Array.of(Types::Blocks.new(*SUPPORTED_ELEMENTS)), default: []
       validates :elements, presence: true, length: {maximum: MAX_ELEMENTS, message: "is too long (maximum is %{count} elements)"}, "block_kit/validators/associated": true
       fixes :elements, truncate: {maximum: MAX_ELEMENTS, dangerous: true}, associated: true
 
       dsl_method :elements, as: :mrkdwn, type: Composition::Mrkdwn, required_fields: [:text], yields: false
       dsl_method :elements, as: :plain_text, type: Composition::PlainText, required_fields: [:text], yields: false
 
-      def initialize(attributes = {})
-        attributes = attributes.with_indifferent_access
-        attributes[:elements] ||= []
-
-        super
-      end
-
       def image(alt_text:, image_url: nil, slack_file: nil)
         if (image_url.nil? && slack_file.nil?) || (image_url && slack_file)
           raise ArgumentError, "Must provide either image_url or slack_file, but not both."

data/lib/block_kit/layout/image.rb

@@ -16,6 +16,8 @@ module BlockKit
       attribute :slack_file, Types::Generic.of_type(Composition::SlackFile)
       plain_text_attribute :title
 
+      alias_attribute :url, :image_url
+
       include Concerns::PlainTextEmojiAssignment.new(:title)
 
       validates :alt_text, presence: true, length: {maximum: MAX_ALT_TEXT_LENGTH}

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

@@ -8,6 +8,8 @@ module BlockKit
       attribute :channel_id, :string
       attribute :style, Types::Generic.of_type(RichText::Elements::MentionStyle)
 
+      alias_attribute :id, :channel_id
+
       validates :channel_id, presence: true
 
       def as_json(*)

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

@@ -8,6 +8,8 @@ module BlockKit
       attribute :user_id, :string
       attribute :style, Types::Generic.of_type(RichText::Elements::MentionStyle)
 
+      alias_attribute :id, :user_id
+
       validates :user_id, presence: true
 
       def as_json(*)

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

@@ -8,6 +8,9 @@ module BlockKit
       attribute :usergroup_id, :string
       attribute :style, Types::Generic.of_type(RichText::Elements::MentionStyle)
 
+      alias_attribute :user_group_id, :usergroup_id
+      alias_attribute :id, :usergroup_id
+
       validates :usergroup_id, presence: true
 
       def as_json(*)
@@ -17,5 +20,7 @@ module BlockKit
         ).compact
       end
     end
+
+    RichText::Elements::UserGroup = RichText::Elements::Usergroup
   end
 end

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

@@ -12,6 +12,7 @@ module BlockKit
       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"
+      autoload :UserGroup, "block_kit/layout/rich_text/elements/usergroup"
 
       # Utility blocks
       autoload :MentionStyle, "block_kit/layout/rich_text/elements/mention_style"

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

@@ -11,7 +11,7 @@ module BlockKit
       ].freeze
 
       attribute :style, :string
-      attribute :elements, Types::Array.of(RichText::Section)
+      attribute :elements, Types::Array.of(RichText::Section), default: []
       attribute :indent, :integer
       attribute :offset, :integer
       attribute :border, :integer

data/lib/block_kit/layout/rich_text.rb

@@ -18,26 +18,19 @@ module BlockKit
         RichText::Section
       ].freeze
 
-      attribute :elements, Types::Array.of(Types::Blocks.new(*SUPPORTED_ELEMENTS))
+      attribute :elements, Types::Array.of(Types::Blocks.new(*SUPPORTED_ELEMENTS)), default: []
       validates :elements, presence: true, "block_kit/validators/associated": true
       fixes :elements, associated: true
 
-      dsl_method :elements, as: :list, type: RichText::List
-      dsl_method :elements, as: :preformatted, type: RichText::Preformatted
-      dsl_method :elements, as: :quote, type: RichText::Quote
-      dsl_method :elements, as: :section, type: RichText::Section
+      dsl_method :elements, as: :rich_text_list, type: RichText::List
+      dsl_method :elements, as: :rich_text_preformatted, type: RichText::Preformatted
+      dsl_method :elements, as: :rich_text_quote, type: RichText::Quote
+      dsl_method :elements, as: :rich_text_section, type: RichText::Section
 
-      alias_method :rich_text_list, :list
-      alias_method :rich_text_preformatted, :preformatted
-      alias_method :rich_text_quote, :quote
-      alias_method :rich_text_section, :section
-
-      def initialize(attributes = {})
-        attributes = attributes.with_indifferent_access
-        attributes[:elements] ||= []
-
-        super
-      end
+      alias_method :list, :rich_text_list
+      alias_method :preformatted, :rich_text_preformatted
+      alias_method :quote, :rich_text_quote
+      alias_method :section, :rich_text_section
 
       def append(element)
         elements << element

data/lib/block_kit/layout/video.rb

@@ -24,6 +24,8 @@ module BlockKit
       attribute :thumbnail_url, :string
       attribute :video_url, :string
 
+      alias_attribute :url, :video_url
+
       include Concerns::PlainTextEmojiAssignment.new(:description, :title)
 
       validates :alt_text, presence: true, length: {maximum: MAX_ALT_TEXT_LENGTH}

data/lib/block_kit/surfaces/base.rb

@@ -20,7 +20,7 @@ module BlockKit
         Layout::Video
       ]
 
-      attribute :blocks, Types::Array.of(Types::Blocks.new(*SUPPORTED_BLOCKS))
+      attribute :blocks, Types::Array.of(Types::Blocks.new(*SUPPORTED_BLOCKS)), default: []
       attribute :private_metadata, :string
       attribute :callback_id, :string
       attribute :external_id, :string

data/lib/block_kit/surfaces/home.rb

@@ -28,13 +28,6 @@ module BlockKit
         Elements::TimePicker,
         Elements::UsersSelect
       ].freeze
-
-      def initialize(attributes = {})
-        attributes = attributes.with_indifferent_access
-        attributes[:blocks] ||= []
-
-        super
-      end
     end
   end
 end

data/lib/block_kit/surfaces/message.rb

@@ -32,7 +32,7 @@ module BlockKit
       ].freeze
 
       attribute :text, :string
-      attribute :blocks, Types::Array.of(Types::Blocks.new(*Layout.all))
+      attribute :blocks, Types::Array.of(Types::Blocks.new(*Layout.all)), default: []
       attribute :thread_ts, :string
       attribute :mrkdwn, :boolean
 
@@ -53,13 +53,6 @@ module BlockKit
       dsl_method :blocks, as: :section, type: Layout::Section
       dsl_method :blocks, as: :video, type: Layout::Video, required_fields: [:alt_text, :title, :thumbnail_url, :video_url], yields: false
 
-      def initialize(attributes = {})
-        attributes = attributes.with_indifferent_access
-        attributes[:blocks] ||= []
-
-        super
-      end
-
       def image(alt_text:, image_url: nil, slack_file: nil, title: nil, emoji: nil, block_id: nil)
         if (image_url.nil? && slack_file.nil?) || (image_url && slack_file)
           raise ArgumentError, "Must provide either image_url or slack_file, but not both."

data/lib/block_kit/surfaces/modal.rb

@@ -54,13 +54,6 @@ module BlockKit
       fixes :submit, truncate: {maximum: MAX_BUTTON_LENGTH}, null_value: {error_types: [:blank]}
       fix :add_default_submit_button
 
-      def initialize(attributes = {})
-        attributes = attributes.with_indifferent_access
-        attributes[:blocks] ||= []
-
-        super
-      end
-
       def as_json(*)
         super.merge(
           title: title&.as_json,

data/lib/block_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BlockKit
-  VERSION = "1.0.3"
+  VERSION = "1.0.5"
 end

data/lib/block_kit.rb

@@ -20,19 +20,19 @@ module BlockKit
 
   autoload :VERSION, "block_kit/version"
 
-  def self.blocks(&block)
-    Blocks.new(&block)
+  def self.blocks(attributes = {}, &block)
+    Blocks.new(attributes, &block)
   end
 
-  def self.home(&block)
-    Surfaces::Home.new(&block)
+  def self.home(attributes = {}, &block)
+    Surfaces::Home.new(attributes, &block)
   end
 
-  def self.modal(&block)
-    Surfaces::Modal.new(&block)
+  def self.modal(attributes = {}, &block)
+    Surfaces::Modal.new(attributes, &block)
   end
 
-  def self.message(&block)
-    Surfaces::Message.new(&block)
+  def self.message(attributes = {}, &block)
+    Surfaces::Message.new(attributes, &block)
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: block-kit
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - David Celis
 bindir: exe
 cert_chain: []
-date: 2025-04-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- ".tool-versions"
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
@@ -184,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.6
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A powerful DSL-based library for Slack's Block Kit framework.
 test_files: []