Skip to content
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

Add description field to option block object #783

Merged
merged 2 commits into from
Oct 2, 2020
Merged

Add description field to option block object #783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45c48ff
add description field
deto-r Aug 18, 2020
465eec9
fix examples
deto-r Aug 18, 2020
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
2 changes: 1 addition & 1 deletion block_element.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ func (c CheckboxGroupsBlockElement) ElementType() MessageElementType {
return c.Type
}

// NewCheckboxGroupsBlockElement returns an instance of a radio block element
// NewCheckboxGroupsBlockElement returns an instance of a checkbox-group block element
func NewCheckboxGroupsBlockElement(actionID string, options ...*OptionBlockObject) *CheckboxGroupsBlockElement {
return &CheckboxGroupsBlockElement{
Type: METCheckboxGroups,
Expand Down
56 changes: 40 additions & 16 deletions block_element_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ func TestNewButtonBlockElement(t *testing.T) {
func TestNewOptionsSelectBlockElement(t *testing.T) {

testOptionText := NewTextBlockObject("plain_text", "Option One", false, false)
testOption := NewOptionBlockObject("test", testOptionText)
testOption := NewOptionBlockObject("test", testOptionText, nil)

option := NewOptionsSelectBlockElement("static_select", nil, "test", testOption)
assert.Equal(t, option.Type, "static_select")
Expand All @@ -43,13 +43,13 @@ func TestNewOptionsSelectBlockElement(t *testing.T) {
func TestNewOptionsGroupSelectBlockElement(t *testing.T) {

testOptionText := NewTextBlockObject("plain_text", "Option One", false, false)
testOption := NewOptionBlockObject("test", testOptionText)
testOption := NewOptionBlockObject("test", testOptionText, nil)
testLabel := NewTextBlockObject("plain_text", "Test Label", false, false)
testGroupOption := NewOptionGroupBlockElement(testLabel, testOption)

optGroup := NewOptionsGroupSelectBlockElement("static_select", nil, "test", testGroupOption)

assert.Equal(t, string(optGroup.Type), "static_select")
assert.Equal(t, optGroup.Type, "static_select")
assert.Equal(t, optGroup.ActionID, "test")
assert.Equal(t, len(optGroup.OptionGroups), 1)

Expand All @@ -58,7 +58,8 @@ func TestNewOptionsGroupSelectBlockElement(t *testing.T) {
func TestNewOptionsMultiSelectBlockElement(t *testing.T) {

testOptionText := NewTextBlockObject("plain_text", "Option One", false, false)
testOption := NewOptionBlockObject("test", testOptionText)
testDescriptionText := NewTextBlockObject("plain_text", "Description One", false, false)
testOption := NewOptionBlockObject("test", testOptionText, testDescriptionText)

option := NewOptionsMultiSelectBlockElement("static_select", nil, "test", testOption)
assert.Equal(t, option.Type, "static_select")
Expand All @@ -70,13 +71,13 @@ func TestNewOptionsMultiSelectBlockElement(t *testing.T) {
func TestNewOptionsGroupMultiSelectBlockElement(t *testing.T) {

testOptionText := NewTextBlockObject("plain_text", "Option One", false, false)
testOption := NewOptionBlockObject("test", testOptionText)
testOption := NewOptionBlockObject("test", testOptionText, nil)
testLabel := NewTextBlockObject("plain_text", "Test Label", false, false)
testGroupOption := NewOptionGroupBlockElement(testLabel, testOption)

optGroup := NewOptionsGroupMultiSelectBlockElement("static_select", nil, "test", testGroupOption)

assert.Equal(t, string(optGroup.Type), "static_select")
assert.Equal(t, optGroup.Type, "static_select")
assert.Equal(t, optGroup.ActionID, "test")
assert.Equal(t, len(optGroup.OptionGroups), 1)

Expand All @@ -89,9 +90,9 @@ func TestNewOverflowBlockElement(t *testing.T) {
overflowOptionTextThree := NewTextBlockObject("plain_text", "Option Three", false, false)

// Build each option, providing a value for the option
overflowOptionOne := NewOptionBlockObject("value-0", overflowOptionTextOne)
overflowOptionTwo := NewOptionBlockObject("value-1", overflowOptionTextTwo)
overflowOptionThree := NewOptionBlockObject("value-2", overflowOptionTextThree)
overflowOptionOne := NewOptionBlockObject("value-0", overflowOptionTextOne, nil)
overflowOptionTwo := NewOptionBlockObject("value-1", overflowOptionTextTwo, nil)
overflowOptionThree := NewOptionBlockObject("value-2", overflowOptionTextThree, nil)

// Build overflow section
overflowElement := NewOverflowBlockElement("test", overflowOptionOne, overflowOptionTwo, overflowOptionThree)
Expand All @@ -113,13 +114,36 @@ func TestNewDatePickerBlockElement(t *testing.T) {

func TestNewPlainTextInputBlockElement(t *testing.T) {

plainTextInputElemnet := NewPlainTextInputBlockElement(nil, "test")
plainTextInputElement := NewPlainTextInputBlockElement(nil, "test")

assert.Equal(t, string(plainTextInputElemnet.Type), "plain_text_input")
assert.Equal(t, plainTextInputElemnet.ActionID, "test")
assert.Equal(t, string(plainTextInputElement.Type), "plain_text_input")
assert.Equal(t, plainTextInputElement.ActionID, "test")

}

func TestNewCheckboxGroupsBlockElement(t *testing.T) {
// Build Text Objects associated with each option
checkBoxOptionTextOne := NewTextBlockObject("plain_text", "Check One", false, false)
checkBoxOptionTextTwo := NewTextBlockObject("plain_text", "Check Two", false, false)
checkBoxOptionTextThree := NewTextBlockObject("plain_text", "Check Three", false, false)

checkBoxDescriptionTextOne := NewTextBlockObject("plain_text", "Description One", false, false)
checkBoxDescriptionTextTwo := NewTextBlockObject("plain_text", "Description Two", false, false)
checkBoxDescriptionTextThree := NewTextBlockObject("plain_text", "Description Three", false, false)

// Build each option, providing a value for the option
checkBoxOptionOne := NewOptionBlockObject("value-0", checkBoxOptionTextOne, checkBoxDescriptionTextOne)
checkBoxOptionTwo := NewOptionBlockObject("value-1", checkBoxOptionTextTwo, checkBoxDescriptionTextTwo)
checkBoxOptionThree := NewOptionBlockObject("value-2", checkBoxOptionTextThree, checkBoxDescriptionTextThree)

// Build checkbox-group element
checkBoxGroupElement := NewCheckboxGroupsBlockElement("test", checkBoxOptionOne, checkBoxOptionTwo, checkBoxOptionThree)

assert.Equal(t, string(checkBoxGroupElement.Type), "checkboxes")
assert.Equal(t, checkBoxGroupElement.ActionID, "test")
assert.Equal(t, len(checkBoxGroupElement.Options), 3)
}

func TestNewRadioButtonsBlockElement(t *testing.T) {

// Build Text Objects associated with each option
Expand All @@ -128,11 +152,11 @@ func TestNewRadioButtonsBlockElement(t *testing.T) {
radioButtonsOptionTextThree := NewTextBlockObject("plain_text", "Option Three", false, false)

// Build each option, providing a value for the option
radioButtonsOptionOne := NewOptionBlockObject("value-0", radioButtonsOptionTextOne)
radioButtonsOptionTwo := NewOptionBlockObject("value-1", radioButtonsOptionTextTwo)
radioButtonsOptionThree := NewOptionBlockObject("value-2", radioButtonsOptionTextThree)
radioButtonsOptionOne := NewOptionBlockObject("value-0", radioButtonsOptionTextOne, nil)
radioButtonsOptionTwo := NewOptionBlockObject("value-1", radioButtonsOptionTextTwo, nil)
radioButtonsOptionThree := NewOptionBlockObject("value-2", radioButtonsOptionTextThree, nil)

// Build overflow section
// Build radio button element
radioButtonsElement := NewRadioButtonsBlockElement("test", radioButtonsOptionOne, radioButtonsOptionTwo, radioButtonsOptionThree)

assert.Equal(t, string(radioButtonsElement.Type), "radio_buttons")
Expand Down
14 changes: 8 additions & 6 deletions block_object.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,16 +190,18 @@ func NewConfirmationBlockObject(title, text, confirm, deny *TextBlockObject) *Co
//
// More Information: https://api.slack.com/reference/messaging/composition-objects#option
type OptionBlockObject struct {
Text *TextBlockObject `json:"text"`
Value string `json:"value"`
URL string `json:"url,omitempty"`
Text *TextBlockObject `json:"text"`
Value string `json:"value"`
Description *TextBlockObject `json:"description,omitempty"`
URL string `json:"url,omitempty"`
}

// NewOptionBlockObject returns an instance of a new Option Block Element
func NewOptionBlockObject(value string, text *TextBlockObject) *OptionBlockObject {
func NewOptionBlockObject(value string, text, description *TextBlockObject) *OptionBlockObject {
return &OptionBlockObject{
Text: text,
Value: value,
Text: text,
Value: value,
Description: description,
}
}

Expand Down
6 changes: 4 additions & 2 deletions block_object_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,11 @@ func TestNewConfirmationBlockObject(t *testing.T) {
func TestNewOptionBlockObject(t *testing.T) {

valTextObj := NewTextBlockObject("plain_text", "testText", false, false)
optObj := NewOptionBlockObject("testOpt", valTextObj)
valDescriptionObj := NewTextBlockObject("plain_text", "testDescription", false, false)
optObj := NewOptionBlockObject("testOpt", valTextObj, valDescriptionObj)

assert.Equal(t, optObj.Text.Text, "testText")
assert.Equal(t, optObj.Description.Text, "testDescription")
assert.Equal(t, optObj.Value, "testOpt")

}
Expand All @@ -56,7 +58,7 @@ func TestNewOptionGroupBlockElement(t *testing.T) {

labelObj := NewTextBlockObject("plain_text", "testLabel", false, false)
valTextObj := NewTextBlockObject("plain_text", "testText", false, false)
optObj := NewOptionBlockObject("testOpt", valTextObj)
optObj := NewOptionBlockObject("testOpt", valTextObj, nil)

optGroup := NewOptionGroupBlockElement(labelObj, optObj)

Expand Down
12 changes: 6 additions & 6 deletions examples/blocks/blocks.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,9 +283,9 @@ func exampleFive() {
overflowOptionTextThree := slack.NewTextBlockObject("plain_text", "Option Three", false, false)

// Build each option, providing a value for the option
overflowOptionOne := slack.NewOptionBlockObject("value-0", overflowOptionTextOne)
overflowOptionTwo := slack.NewOptionBlockObject("value-1", overflowOptionTextTwo)
overflowOptionThree := slack.NewOptionBlockObject("value-2", overflowOptionTextThree)
overflowOptionOne := slack.NewOptionBlockObject("value-0", overflowOptionTextOne, nil)
overflowOptionTwo := slack.NewOptionBlockObject("value-1", overflowOptionTextTwo, nil)
overflowOptionThree := slack.NewOptionBlockObject("value-2", overflowOptionTextThree, nil)

// Build overflow section
overflow := slack.NewOverflowBlockElement("", overflowOptionOne, overflowOptionTwo, overflowOptionThree)
Expand Down Expand Up @@ -365,9 +365,9 @@ func exampleSix() {
readTxt := slack.NewTextBlockObject("plain_text", "Read it", false, false)
saveTxt := slack.NewTextBlockObject("plain_text", "Save it", false, false)

editOpt := slack.NewOptionBlockObject("value-0", editTxt)
readOpt := slack.NewOptionBlockObject("value-1", readTxt)
saveOpt := slack.NewOptionBlockObject("value-2", saveTxt)
editOpt := slack.NewOptionBlockObject("value-0", editTxt, nil)
readOpt := slack.NewOptionBlockObject("value-1", readTxt, nil)
saveOpt := slack.NewOptionBlockObject("value-2", saveTxt, nil)

availableOption := slack.NewOptionsSelectBlockElement("static_select", manageTxt, "", editOpt, readOpt, saveOpt)

Expand Down
2 changes: 1 addition & 1 deletion examples/modal_users/users.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ func createOptionBlockObjects(options []string, users bool) []*slack.OptionBlock
text = o
}
optionText := slack.NewTextBlockObject(slack.PlainTextType, text, false, false)
optionBlockObjects = append(optionBlockObjects, slack.NewOptionBlockObject(o, optionText))
optionBlockObjects = append(optionBlockObjects, slack.NewOptionBlockObject(o, optionText, nil))
}
return optionBlockObjects
}