Roll reason support

Author: gitsang

README.md

@@ -27,6 +27,16 @@ This Mattermost plugin adds a `/roll` slash command to roll all kinds of virtual
 
 ![demo](doc/demo_many_dice.png)
 
+- Add roll reason at newline: 
+
+```
+/roll 3d1 +3 3d1
+your roll reason
+other roll reason
+```
+
+![demo](doc/demo_reason.png)
+
 - **[Up to version 3.0.x]** Add `sum` at the end to sum results automatically: `/roll 5 d8 13D20 sum`. In later versions, the sum is always displayed without having to add `sum`.
 
 

doc/demo_reason.png

@@ -103,6 +103,13 @@ func (p *Plugin) generateDicePost(query, userID, channelID, rootID string) (*mod
 		displayName = user.Username
 	}
 
+	reason := ""
+	queries := strings.SplitN(query, "\n", 2)
+	if len(queries) == 2 {
+		reason = queries[1]
+	}
+	query = queries[0]
+
 	text := fmt.Sprintf("**%s** rolls *%s* = ", displayName, query)
 	sum := 0
 	rollRequests := strings.Fields(query)
@@ -146,6 +153,11 @@ func (p *Plugin) generateDicePost(query, userID, channelID, rootID string) (*mod
 		text += fmt.Sprintf("\n- %s", strings.Join(formattedRollDetails, "\n- "))
 	}
 
+	// Display roll reason
+	if reason != "" {
+		text += fmt.Sprintf("\n```\n%s\n```", reason)
+	}
+
 	return &model.Post{
 		UserId:    p.diceBotID,
 		ChannelId: channelID,

server/plugin.go

@@ -87,6 +87,42 @@ func TestGoodInputs(t *testing.T) {
 	}
 }
 
+func TestReason(t *testing.T) {
+	p, api := initTestPlugin()
+	var post *model.Post
+	api.On("CreatePost", mock.AnythingOfType("*model.Post")).Return(nil, nil).Run(func(args mock.Arguments) {
+		post = args.Get(0).(*model.Post)
+	})
+	assert.Nil(t, p.OnActivate())
+
+	testCases := []struct {
+		inputDiceRequest string
+		expectedText     string
+	}{
+		{
+			inputDiceRequest: "d1\nRoll reason",
+			expectedText:     "**User** rolls *d1* = **1**\n```\nRoll reason\n```",
+		},
+		{
+			inputDiceRequest: "2d1\nRoll reason\nother reason",
+			expectedText:     "**User** rolls *2d1* = **2**\n- 2d1: 1 1\n```\nRoll reason\nother reason\n```",
+		},
+	}
+	for _, testCase := range testCases {
+		command := &model.CommandArgs{
+			Command: "/roll " + testCase.inputDiceRequest,
+			UserId:  "userid",
+		}
+		response, err := p.ExecuteCommand(&plugin.Context{}, command)
+		testLabel := "Testing " + testCase.inputDiceRequest
+		assert.Nil(t, err, testLabel)
+		assert.NotNil(t, response, testLabel)
+		assert.NotNil(t, post, testLabel)
+		assert.NotNil(t, post.Message, testLabel)
+		assert.Equal(t, testCase.expectedText, strings.TrimSpace(post.Message), testLabel)
+	}
+}
+
 func initTestPlugin() (*Plugin, *plugintest.API) {
 	api := &plugintest.API{}
 	api.On("RegisterCommand", mock.Anything).Return(nil)