Skip to content

Add description to additional elements #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CGA1123 merged 4 commits into from
Nov 22, 2024
Merged

Add description to additional elements #195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ffca240
Add description support to option groups
resputin Nov 20, 2024
f24d2de
Add description support to multi static select
resputin Nov 20, 2024
b9dd97e
Add description support to radio buttons
resputin Nov 20, 2024
2b4c557
Add description support to static select
resputin Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/slack/block_kit/composition/option_group.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ def initialize(label:, emoji: nil)
yield(self) if block_given?
end

def option(text:, value:, emoji: nil, initial: false)
@options << Option.new(text: text, value: value, emoji: emoji, initial: initial)
def option(text:, value:, description: nil, emoji: nil, initial: false)
@options << Option.new(text: text, value: value, description: description, emoji: emoji, initial: initial)

self
end
Expand Down
3 changes: 2 additions & 1 deletion lib/slack/block_kit/element/multi_static_select.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,12 @@ def initialize(
yield(self) if block_given?
end

def option(value:, text:, initial: false, emoji: nil)
def option(value:, text:, description: nil, initial: false, emoji: nil)
@options ||= []
@options << Composition::Option.new(
value: value,
text: text,
description: description,
emoji: emoji,
initial: initial
)
Expand Down
3 changes: 2 additions & 1 deletion lib/slack/block_kit/element/radio_buttons.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@ def initialize(action_id:, focus_on_load: nil)
yield(self) if block_given?
end

def option(value:, text:, initial: false, emoji: nil)
def option(value:, text:, description: nil, initial: false, emoji: nil)
option = Composition::Option.new(
value: value,
text: text,
description: description,
initial: initial,
emoji: emoji
)
Expand Down
3 changes: 2 additions & 1 deletion lib/slack/block_kit/element/static_select.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,12 @@ def initialize(placeholder:, action_id:, emoji: nil, focus_on_load: nil)
yield(self) if block_given?
end

def option(value:, text:, initial: false, emoji: nil)
def option(value:, text:, description: nil, initial: false, emoji: nil)
@options ||= []
@options << Composition::Option.new(
value: value,
text: text,
description: description,
emoji: emoji,
initial: initial
)
Expand Down
33 changes: 30 additions & 3 deletions spec/lib/slack/block_kit/composition/option_group_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,25 @@
expect(instance.options.first).to be_initial
end

it 'supports option descriptions' do
instance = described_class.new(label: 'hello')
instance.option(text: 'option', value: 'o', description: 'description text')

option_json = instance.options.first.as_json
expect(option_json[:description]).to eq(
{ type: 'plain_text', text: 'description text' }
)
end

it 'appends a Slack::BlockKit::Composition::Option object' do
instance = described_class.new(label: 'hello')
expected = Slack::BlockKit::Composition::Option.new(text: 'option', value: 'o')
expected = Slack::BlockKit::Composition::Option.new(
text: 'option',
value: 'o',
description: 'description'
)

instance.option(text: 'option', value: 'o')
instance.option(text: 'option', value: 'o', description: 'description')

expect(instance.options.last.as_json).to eq(expected.as_json)
end
Expand All @@ -58,14 +72,27 @@
{
label: Slack::BlockKit::Composition::PlainText.new(text: 'label', emoji: true).as_json,
options: [
Slack::BlockKit::Composition::Option.new(text: 'text', value: 'value')
Slack::BlockKit::Composition::Option.new(
text: 'text',
value: 'value'
),
Slack::BlockKit::Composition::Option.new(
text: 'text with description',
value: 'value2',
description: 'some description'
)
].map(&:as_json)
}
end

it 'correctly serializes' do
instance = described_class.new(label: 'label', emoji: true) do |option_group|
option_group.option(text: 'text', value: 'value')
option_group.option(
text: 'text with description',
value: 'value2',
description: 'some description'
)
end

expect(instance.as_json).to eq(expected)
Expand Down
66 changes: 47 additions & 19 deletions spec/lib/slack/block_kit/element/multi_static_select_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,21 +26,33 @@
text: '__TEXT_1__',
type: 'plain_text'
},
value: '__VALUE_1__'
value: '__VALUE_1__',
description: {
type: 'plain_text',
text: '__DESCRIPTION_1__'
}
},
{
text: {
text: '__TEXT_2__',
type: 'plain_text'
},
value: '__VALUE_2__'
value: '__VALUE_2__',
description: {
type: 'plain_text',
text: '__DESCRIPTION_2__'
}
},
{
text: {
text: '__TEXT_3__',
type: 'plain_text'
},
value: '__VALUE_3__'
value: '__VALUE_3__',
description: {
type: 'plain_text',
text: '__DESCRIPTION_3__'
}
}
]
}
Expand All @@ -54,7 +66,11 @@
text: '__TEXT_2__',
type: 'plain_text'
},
value: '__VALUE_2__'
value: '__VALUE_2__',
description: {
type: 'plain_text',
text: '__DESCRIPTION_2__'
}
}
]
end
Expand All @@ -66,21 +82,33 @@
text: '__TEXT_1__',
type: 'plain_text'
},
value: '__VALUE_1__'
value: '__VALUE_1__',
description: {
type: 'plain_text',
text: '__DESCRIPTION_1__'
}
},
{
text: {
text: '__TEXT_2__',
type: 'plain_text'
},
value: '__VALUE_2__'
value: '__VALUE_2__',
description: {
type: 'plain_text',
text: '__DESCRIPTION_2__'
}
},
{
text: {
text: '__TEXT_3__',
type: 'plain_text'
},
value: '__VALUE_3__'
value: '__VALUE_3__',
description: {
type: 'plain_text',
text: '__DESCRIPTION_3__'
}
}
]
end
Expand Down Expand Up @@ -196,9 +224,9 @@

context 'with options' do
subject(:as_json) do
instance.option(value: '__VALUE_1__', text: '__TEXT_1__')
instance.option(value: '__VALUE_2__', text: '__TEXT_2__')
instance.option(value: '__VALUE_3__', text: '__TEXT_3__')
instance.option(value: '__VALUE_1__', text: '__TEXT_1__', description: '__DESCRIPTION_1__')
instance.option(value: '__VALUE_2__', text: '__TEXT_2__', description: '__DESCRIPTION_2__')
instance.option(value: '__VALUE_3__', text: '__TEXT_3__', description: '__DESCRIPTION_3__')
instance.as_json
end

Expand All @@ -211,9 +239,9 @@

context 'with options and initial option' do
subject(:as_json) do
instance.option(value: '__VALUE_1__', text: '__TEXT_1__')
instance.option(value: '__VALUE_2__', text: '__TEXT_2__', initial: true)
instance.option(value: '__VALUE_3__', text: '__TEXT_3__')
instance.option(value: '__VALUE_1__', text: '__TEXT_1__', description: '__DESCRIPTION_1__')
instance.option(value: '__VALUE_2__', text: '__TEXT_2__', description: '__DESCRIPTION_2__', initial: true)
instance.option(value: '__VALUE_3__', text: '__TEXT_3__', description: '__DESCRIPTION_3__')

instance.as_json
end
Expand All @@ -231,9 +259,9 @@
context 'with option_groups' do
subject(:as_json) do
instance.option_group(label: '__GROUP__') do |group|
group.option(value: '__VALUE_1__', text: '__TEXT_1__')
group.option(value: '__VALUE_2__', text: '__TEXT_2__')
group.option(value: '__VALUE_3__', text: '__TEXT_3__')
group.option(value: '__VALUE_1__', text: '__TEXT_1__', description: '__DESCRIPTION_1__')
group.option(value: '__VALUE_2__', text: '__TEXT_2__', description: '__DESCRIPTION_2__')
group.option(value: '__VALUE_3__', text: '__TEXT_3__', description: '__DESCRIPTION_3__')
end
instance.as_json
end
Expand All @@ -248,9 +276,9 @@
context 'with option_groups and initial option' do
subject(:as_json) do
instance.option_group(label: '__GROUP__') do |group|
group.option(value: '__VALUE_1__', text: '__TEXT_1__')
group.option(value: '__VALUE_2__', text: '__TEXT_2__', initial: true)
group.option(value: '__VALUE_3__', text: '__TEXT_3__')
group.option(value: '__VALUE_1__', text: '__TEXT_1__', description: '__DESCRIPTION_1__')
group.option(value: '__VALUE_2__', text: '__TEXT_2__', description: '__DESCRIPTION_2__', initial: true)
group.option(value: '__VALUE_3__', text: '__TEXT_3__', description: '__DESCRIPTION_3__')
end

instance.as_json
Expand Down
29 changes: 25 additions & 4 deletions spec/lib/slack/block_kit/element/radio_buttons_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,21 @@
text: {
type: 'plain_text',
text: 'Option 1'
},
description: {
type: 'plain_text',
text: 'Description 1'
}
},
{
value: 'option-2',
text: {
type: 'plain_text',
text: 'Option 2'
},
description: {
type: 'plain_text',
text: 'Description 2'
}
},
{
Expand All @@ -46,6 +54,11 @@
type: 'plain_text',
text: 'Option 3',
emoji: true
},
description: {
type: 'plain_text',
text: 'Description 3',
emoji: true
}
}
],
Expand All @@ -54,15 +67,19 @@
text: {
type: 'plain_text',
text: 'Option 2'
},
description: {
type: 'plain_text',
text: 'Description 2'
}
}
}
end

it 'correctly serializes' do
instance.option(value: 'option-1', text: 'Option 1')
instance.option(value: 'option-2', text: 'Option 2', initial: true)
instance.option(value: 'option-3', text: 'Option 3', initial: true, emoji: true)
instance.option(value: 'option-1', text: 'Option 1', description: 'Description 1')
instance.option(value: 'option-2', text: 'Option 2', description: 'Description 2', initial: true)
instance.option(value: 'option-3', text: 'Option 3', description: 'Description 3', initial: true, emoji: true)
expect(as_json).to eq(expected_json)
end

Expand Down Expand Up @@ -99,6 +116,10 @@
text: {
type: 'plain_text',
text: 'Option 1'
},
description: {
type: 'plain_text',
text: 'Description 1'
}
}
],
Expand All @@ -124,7 +145,7 @@
end

before do
instance.option(value: 'option-1', text: 'Option 1')
instance.option(value: 'option-1', text: 'Option 1', description: 'Description 1')
instance.confirmation_dialog do |confirm|
confirm.title(text: '__CONFIRM_TITTLE__')
confirm.plain_text(text: '__CONFIRM_TEXT__')
Expand Down
22 changes: 17 additions & 5 deletions spec/lib/slack/block_kit/element/static_select_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@
text: '__TEXT_2__',
type: 'plain_text'
},
description: {
type: 'plain_text',
text: '__DESCRIPTION_2__'
},
value: '__VALUE_2__'
},
{
Expand All @@ -53,7 +57,11 @@
text: '__TEXT_2__',
type: 'plain_text'
},
value: '__VALUE_2__'
value: '__VALUE_2__',
description: {
type: 'plain_text',
text: '__DESCRIPTION_2__'
}
}
end

Expand All @@ -71,6 +79,10 @@
text: '__TEXT_2__',
type: 'plain_text'
},
description: {
type: 'plain_text',
text: '__DESCRIPTION_2__'
},
value: '__VALUE_2__'
},
{
Expand Down Expand Up @@ -156,7 +168,7 @@
context 'with options' do
subject(:as_json) do
instance.option(value: '__VALUE_1__', text: '__TEXT_1__')
instance.option(value: '__VALUE_2__', text: '__TEXT_2__')
instance.option(value: '__VALUE_2__', text: '__TEXT_2__', description: '__DESCRIPTION_2__')
instance.option(value: '__VALUE_3__', text: '__TEXT_3__')
instance.as_json
end
Expand All @@ -171,7 +183,7 @@
context 'with options and initial option' do
subject(:as_json) do
instance.option(value: '__VALUE_1__', text: '__TEXT_1__')
instance.option(value: '__VALUE_2__', text: '__TEXT_2__', initial: true)
instance.option(value: '__VALUE_2__', text: '__TEXT_2__', description: '__DESCRIPTION_2__', initial: true)
instance.option(value: '__VALUE_3__', text: '__TEXT_3__')

instance.as_json
Expand All @@ -188,7 +200,7 @@
subject(:as_json) do
instance.option_group(label: '__GROUP__') do |group|
group.option(value: '__VALUE_1__', text: '__TEXT_1__')
group.option(value: '__VALUE_2__', text: '__TEXT_2__')
group.option(value: '__VALUE_2__', text: '__TEXT_2__', description: '__DESCRIPTION_2__')
group.option(value: '__VALUE_3__', text: '__TEXT_3__')
end
instance.as_json
Expand All @@ -205,7 +217,7 @@
subject(:as_json) do
instance.option_group(label: '__GROUP__') do |group|
group.option(value: '__VALUE_1__', text: '__TEXT_1__')
group.option(value: '__VALUE_2__', text: '__TEXT_2__', initial: true)
group.option(value: '__VALUE_2__', text: '__TEXT_2__', description: '__DESCRIPTION_2__', initial: true)
group.option(value: '__VALUE_3__', text: '__TEXT_3__')
end

Expand Down
Loading