Rely on ActiveModel's :default option

davidcelis · davidcelis · commit 76cf04c8d35d · 2025-06-02T08:44:48.000-07:00
diff --git a/lib/block_kit/blocks.rb b/lib/block_kit/blocks.rb
@@ -4,7 +4,7 @@
 
 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,14 +22,7 @@ class Blocks < Base
     delegate_missing_to :blocks
 
     def initialize(attributes = {})
-      attributes = case attributes
-      when Array
-        {blocks: attributes}
-      when Hash
-        attributes.with_indifferent_access.tap { |attrs| attrs[:blocks] ||= [] }
-      else
-        raise ArgumentError, "Expected a Hash of attributes or Array of blocks, instead got #{attributes_or_blocks.class}"
-      end
+      attributes = {blocks: attributes} if attributes.is_a?(Array)
 
       super
     end
diff --git a/lib/block_kit/composition/dispatch_action_config.rb b/lib/block_kit/composition/dispatch_action_config.rb
@@ -10,7 +10,7 @@ class DispatchActionConfig < Base
         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]}
 
@@ -22,8 +22,7 @@ class DispatchActionConfig < Base
         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
 
diff --git a/lib/block_kit/concerns/has_rich_text_elements.rb b/lib/block_kit/concerns/has_rich_text_elements.rb
@@ -6,7 +6,7 @@ module HasRichTextElements
       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 HasRichTextElements
         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
diff --git a/lib/block_kit/elements/overflow.rb b/lib/block_kit/elements/overflow.rb
@@ -9,7 +9,7 @@ class Overflow < Base
 
       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
 
diff --git a/lib/block_kit/layout/actions.rb b/lib/block_kit/layout/actions.rb
@@ -28,14 +28,7 @@ class Actions < Base
         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
 
diff --git a/lib/block_kit/layout/context.rb b/lib/block_kit/layout/context.rb
@@ -12,20 +12,13 @@ class Context < Base
         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."
diff --git a/lib/block_kit/layout/rich_text.rb b/lib/block_kit/layout/rich_text.rb
@@ -18,7 +18,7 @@ class RichText < Base
         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
 
@@ -32,13 +32,6 @@ class RichText < Base
       alias_method :quote, :rich_text_quote
       alias_method :section, :rich_text_section
 
-      def initialize(attributes = {})
-        attributes = attributes.with_indifferent_access
-        attributes[:elements] ||= []
-
-        super
-      end
-
       def append(element)
         elements << element
 
diff --git a/lib/block_kit/surfaces/base.rb b/lib/block_kit/surfaces/base.rb
@@ -20,7 +20,7 @@ class Base < BlockKit::Base
         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
diff --git a/lib/block_kit/surfaces/home.rb b/lib/block_kit/surfaces/home.rb
@@ -28,13 +28,6 @@ class Home < Base
         Elements::TimePicker,
         Elements::UsersSelect
       ].freeze
-
-      def initialize(attributes = {})
-        attributes = attributes.with_indifferent_access
-        attributes[:blocks] ||= []
-
-        super
-      end
     end
   end
 end
diff --git a/lib/block_kit/surfaces/message.rb b/lib/block_kit/surfaces/message.rb
@@ -32,7 +32,7 @@ class Message < BlockKit::Base
       ].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 @@ class Message < BlockKit::Base
       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."
diff --git a/lib/block_kit/surfaces/modal.rb b/lib/block_kit/surfaces/modal.rb
@@ -54,13 +54,6 @@ class Modal < Base
       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,
diff --git a/spec/block_kit/blocks_spec.rb b/spec/block_kit/blocks_spec.rb
@@ -259,7 +259,7 @@
         :block_kit_rich_text,
         :block_kit_section,
         :block_kit_video
-      )
+      ).with_default_value([])
     end
   end
 
diff --git a/spec/block_kit/composition/dispatch_action_config_spec.rb b/spec/block_kit/composition/dispatch_action_config_spec.rb
@@ -27,7 +27,7 @@
   end
 
   context "attributes" do
-    it { is_expected.to have_attribute(:trigger_actions_on).with_type(:set).containing(:string) }
+    it { is_expected.to have_attribute(:trigger_actions_on).with_type(:set).containing(:string).with_default_value(BlockKit::TypedSet.new(ActiveModel::Type::String.new)) }
     it { is_expected.to alias_attribute(:trigger_actions_on).as(:triggers) }
   end
 
diff --git a/spec/block_kit/elements/overflow_spec.rb b/spec/block_kit/elements/overflow_spec.rb
@@ -42,7 +42,7 @@
   end
 
   context "attributes" do
-    it { is_expected.to have_attribute(:options).with_type(:array).containing(:block_kit_overflow_option) }
+    it { is_expected.to have_attribute(:options).with_type(:array).containing(:block_kit_overflow_option).with_default_value([]) }
 
     it_behaves_like "a block with an action_id"
     it_behaves_like "a block that is confirmable"
diff --git a/spec/block_kit/layout/actions_spec.rb b/spec/block_kit/layout/actions_spec.rb
@@ -530,7 +530,7 @@
         :block_kit_timepicker,
         :block_kit_users_select,
         :block_kit_workflow_button
-      )
+      ).with_default_value([])
     end
 
     it_behaves_like "a block with a block_id"
diff --git a/spec/block_kit/layout/context_spec.rb b/spec/block_kit/layout/context_spec.rb
@@ -118,7 +118,7 @@
   end
 
   context "attributes" do
-    it { is_expected.to have_attribute(:elements).with_type(:array).containing(:block_kit_image, :block_kit_mrkdwn, :block_kit_plain_text) }
+    it { is_expected.to have_attribute(:elements).with_type(:array).containing(:block_kit_image, :block_kit_mrkdwn, :block_kit_plain_text).with_default_value([]) }
 
     it_behaves_like "a block with a block_id"
 
diff --git a/spec/block_kit/layout/rich_text_spec.rb b/spec/block_kit/layout/rich_text_spec.rb
@@ -75,7 +75,7 @@
   end
 
   context "attributes" do
-    it { is_expected.to have_attribute(:elements).with_type(:array).containing(:block_kit_rich_text_list, :block_kit_rich_text_section, :block_kit_rich_text_preformatted, :block_kit_rich_text_quote) }
+    it { is_expected.to have_attribute(:elements).with_type(:array).containing(:block_kit_rich_text_list, :block_kit_rich_text_section, :block_kit_rich_text_preformatted, :block_kit_rich_text_quote).with_default_value([]) }
 
     it_behaves_like "a block with a block_id"
   end
diff --git a/spec/block_kit/surfaces/home_spec.rb b/spec/block_kit/surfaces/home_spec.rb
@@ -236,7 +236,7 @@
         :block_kit_rich_text,
         :block_kit_section,
         :block_kit_video
-      )
+      ).with_default_value([])
     end
   end
 
diff --git a/spec/block_kit/surfaces/message_spec.rb b/spec/block_kit/surfaces/message_spec.rb
@@ -254,7 +254,7 @@
         :block_kit_rich_text,
         :block_kit_section,
         :block_kit_video
-      )
+      ).with_default_value([])
     end
   end
 
diff --git a/spec/block_kit/surfaces/modal_spec.rb b/spec/block_kit/surfaces/modal_spec.rb
@@ -253,7 +253,7 @@
         :block_kit_rich_text,
         :block_kit_section,
         :block_kit_video
-      )
+      ).with_default_value([])
     end
   end
 
diff --git a/spec/support/matchers/have_attribute.rb b/spec/support/matchers/have_attribute.rb
@@ -40,7 +40,13 @@
       end
     end
 
-    @expected_type == @actual_type && (@expected_item_types.nil? || @expected_item_types.sort == @actual_item_types.sort)
+    if defined?(@expected_default_value)
+      @actual_default_value = described_class.new.public_send(attribute_name)
+    end
+
+    @expected_type == @actual_type &&
+      (@expected_item_types.nil? || @expected_item_types.sort == @actual_item_types.sort) &&
+      @expected_default_value == @actual_default_value
   end
 
   chain :with_type do |expected_type|
@@ -53,17 +59,23 @@
     @expected_item_types = item_types
   end
 
+  chain :with_default_value do |default_value|
+    @expected_default_value = default_value
+  end
+
   failure_message do |object|
     responder = get_class(object)
     active_model_type = get_active_model_type(responder)
 
     message = "expected #{responder} to have attribute `#{attribute_name}'"
     message += " with type `#{@expected_type}'" if @expected_type
     message += " containing `#{@expected_item_types}'" if @expected_item_types
+    message += " with default value `#{@expected_default_value}'" if defined?(@expected_default_value)
 
     message += if active_model_type.present?
       msg = ", but its type is `#{@actual_type}'"
       msg += " containing `#{@actual_item_types}'" if @actual_item_types
+      msg += " and default value `#{@actual_default_value}'" if @actual_default_value
       msg
     else
       ", but it doesn't"
diff --git a/spec/support/shared_examples/has_rich_text_elements.rb b/spec/support/shared_examples/has_rich_text_elements.rb
@@ -1,7 +1,7 @@
 require "spec_helper"
 
 RSpec.shared_examples_for "a block that has rich text elements" do
-  it { is_expected.to have_attribute(:elements).with_type(:array).containing(*BlockKit::Layout::RichText::Elements.all.map { |t| :"block_kit_#{t.type}" }) }
+  it { is_expected.to have_attribute(:elements).with_type(:array).containing(*BlockKit::Layout::RichText::Elements.all.map { |t| :"block_kit_#{t.type}" }).with_default_value([]) }
 
   describe "#broadcast" do
     it "adds a broadcast element" do

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ class Base < BlockKit::Base`
`20`	`20`	`Layout::Video`
`21`	`21`	`]`
`22`	`22`
`23`		`- attribute :blocks, Types::Array.of(Types::Blocks.new(*SUPPORTED_BLOCKS))`
	`23`	`+ attribute :blocks, Types::Array.of(Types::Blocks.new(*SUPPORTED_BLOCKS)), default: []`
`24`	`24`	`attribute :private_metadata, :string`
`25`	`25`	`attribute :callback_id, :string`
`26`	`26`	`attribute :external_id, :string`