bot.*Context.ReplyEmbedAttachmentImageURL - Code Metrics - Inspection of "Added slap command" - FlameInTheDark/dtbot - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a266ab...6dd3ac )

by Viktor

created 2019-05-15 11:19 UTC

bot.*Context.ReplyEmbedAttachmentImageURL A

↳ Parent: bot/reply.go

Complexity

Conditions

Size

Total Lines	6
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	6
nop	2
dl	0
loc	6
rs	10
c	0
b	0
f	0

package bot

import (
	"fmt"
	"io"

	"github.com/bwmarrin/discordgo"
)

// NewEmbedStruct generated embed
type NewEmbedStruct struct {
	*discordgo.MessageSend
	embLength int
}

func truncateText(text string, length int) string {
	if length > 3 && len(text) > length && len(text) > 3 {
		text = text[:length-3] + "..."
	}
	return text
}

// NewEmbed creates new embed
func NewEmbed(title string) *NewEmbedStruct {
	title = truncateText(title, 256)
	return &NewEmbedStruct{&discordgo.MessageSend{Embed: &discordgo.MessageEmbed{Title: title}}, len(title)}
}

// CheckLength returns true if length of embed chars less then 6000
func (emb *NewEmbedStruct) CheckLength(newLength int) bool {
	if emb.embLength + newLength <= 6000 {
		return true
	}
	return false
}

// Field adds field to embed
func (emb *NewEmbedStruct) Field(name, value string, inline bool) *NewEmbedStruct {
	if len(name) > 0 && len(value) > 0 {
		name = truncateText(name, 256)
		value = truncateText(value, 1024)
		newLength := len(name + value)
		if emb.CheckLength(newLength) {
			emb.Embed.Fields = append(emb.Embed.Fields,
				&discordgo.MessageEmbedField{
					Name:   name,
					Value:  value,
					Inline: inline})
			emb.embLength += newLength
		}
	}
	return emb
}

// TimeStamp adds timestamp to footer of embed
func (emb *NewEmbedStruct) TimeStamp(ts string) *NewEmbedStruct {
	emb.Embed.Timestamp = ts
	return emb
}

// Author adds author to embed
func (emb *NewEmbedStruct) Author(name, url, iconURL string) *NewEmbedStruct {
	name = truncateText(name, 256)
	newLength := len(name)
	if emb.CheckLength(newLength) {
		emb.Embed.Author = &discordgo.MessageEmbedAuthor{URL: url, Name: name, IconURL: iconURL}
		emb.embLength += newLength
	}
	return emb
}

// Desc adds description to embed
func (emb *NewEmbedStruct) Desc(desc string) *NewEmbedStruct {
	desc = truncateText(desc, 2048)
	newLength := len(desc)
	if emb.CheckLength(newLength) {
		emb.Embed.Description = desc
		emb.embLength += newLength
	}
	return emb
}

// URL adds url to embed description
func (emb *NewEmbedStruct) URL(url string) *NewEmbedStruct {
	emb.Embed.URL = url
	return emb
}

// Footer adds footer text
func (emb *NewEmbedStruct) Footer(text string) *NewEmbedStruct {
	text = truncateText(text, 2048)
	newLength := len(text)
	if emb.CheckLength(newLength) {
		emb.Embed.Footer = &discordgo.MessageEmbedFooter{Text: text}
		emb.embLength += newLength
	}
	return emb
}

// Color adds color to embed
func (emb *NewEmbedStruct) Color(color int) *NewEmbedStruct {
	emb.Embed.Color = color
	return emb
}

// AttachImg adds attached image to embed from io.Reader
func (emb *NewEmbedStruct) AttachImg(name string, file io.Reader) *NewEmbedStruct {
	emb.Embed.Image = &discordgo.MessageEmbedImage{URL: "attachment://" + name}
	emb.Files = append(emb.Files, &discordgo.File{Name: name, Reader: file})
	return emb
}

// AttachImgURL adds attached image to embed from url
func (emb *NewEmbedStruct) AttachImgURL(url string) *NewEmbedStruct {
	emb.Embed.Image = &discordgo.MessageEmbedImage{URL: url}
	return emb
}

// AttachThumbURL adds attached thumbnail to embed from url
func (emb *NewEmbedStruct) AttachThumbURL(url string) *NewEmbedStruct {
	emb.Embed.Thumbnail = &discordgo.MessageEmbedThumbnail{URL: url}
	return emb
}

// Send send embed message to Discord
func (emb *NewEmbedStruct) Send(ctx *Context) *discordgo.Message {
	msg, err := ctx.Discord.ChannelMessageSendComplex(ctx.TextChannel.ID, emb.MessageSend)
	if err != nil {
		fmt.Println("Error whilst sending embed message, ", err)
		return nil
	}
	ctx.BotMsg.Add(ctx, msg.ID)
	return msg
}

// SendPM send embed personal message to Discord
func (emb *NewEmbedStruct) SendPM(ctx *Context) *discordgo.Message {
	ch, err := ctx.Discord.UserChannelCreate(ctx.User.ID)
	if err != nil {
		fmt.Println("Error whilst creating private channel, ", err)
		return nil
	}
	msg, err := ctx.Discord.ChannelMessageSendComplex(ch.ID, emb.MessageSend)
	if err != nil {
		fmt.Println("Error whilst sending embed message, ", err)
		return nil
	}
	return msg
}

// GetEmbed returns discords embed
func (emb *NewEmbedStruct) GetEmbed() *discordgo.MessageEmbed {
	return emb.Embed
}

// Reply reply on massage
func (ctx *Context) Reply(content string) *discordgo.Message {
	msg, err := ctx.Discord.ChannelMessageSend(ctx.TextChannel.ID, content)
	if err != nil {
		fmt.Println("Error whilst sending message,", err)
		return nil
	}
	ctx.BotMsg.Add(ctx, msg.ID)
	return msg
}

// ReplyFile reply on massage with file
func (ctx *Context) ReplyFile(name string, r io.Reader) *discordgo.Message {
	msg, err := ctx.Discord.ChannelFileSend(ctx.TextChannel.ID, name, r)
	if err != nil {
		fmt.Println("Error whilst sending file,", err)
		return nil
	}
	ctx.BotMsg.Add(ctx, msg.ID)
	return msg
}

// EditEmbed edits embed message by id
func (ctx *Context) EditEmbed(ID, name, value string, inline bool) {
	_, err := ctx.Discord.ChannelMessageEditEmbed(ctx.TextChannel.ID, ID, NewEmbed("").
		Color(ctx.GetGuild().EmbedColor).
		Footer(fmt.Sprintf("%v %v", ctx.Loc("requested_by"), ctx.User.Username)).
		Field(name, value, inline).
		GetEmbed())
	if err != nil {
		ctx.Log("Message", ctx.Guild.ID, err.Error())
	}
}

// ReplyEmbed reply on message with embed message
func (ctx *Context) ReplyEmbed(name, content string) *discordgo.Message {
	return NewEmbed("").
		Field(name, content, false).
		Footer(ctx.Loc("requested_by") + ": " + ctx.User.Username).
		Color(ctx.GetGuild().EmbedColor).
		Send(ctx)
}

// ReplyEmbedPM sends embed in personal channel
func (ctx *Context) ReplyEmbedPM(name, content string) *discordgo.Message {
	return NewEmbed("").
		Field(name, content, false).
		Footer(ctx.Loc("requested_from") + ": " + ctx.Guild.Name).
		Color(ctx.GetGuild().EmbedColor).
		SendPM(ctx)
}

// ReplyPM sends reply message to user personal channel
func (ctx *Context) ReplyPM(content string) *discordgo.Message {
	ch, err := ctx.Discord.UserChannelCreate(ctx.User.ID)
	if err != nil {
		ctx.Log("reply_pm", "", fmt.Sprintf("Error whilst creating private channel: %v", err.Error()))
		return nil
	}
	msg, err := ctx.Discord.ChannelMessageSend(ch.ID, content)
	if err != nil {
		ctx.Log("reply_pm", "", fmt.Sprintf("ReplyPM error: %v", err.Error()))
	}
	return msg
}

// ReplyEmbedAttachment reply on message with embed message with attachment
func (ctx *Context) ReplyEmbedAttachment(name, content, fileName string, file io.Reader) *discordgo.Message {
	return NewEmbed("").
		Field(name, content, false).
		AttachImg(fileName, file).
		Footer(ctx.Loc("requested_by") + ": " + ctx.User.Username).
		Color(ctx.GetGuild().EmbedColor).
		Send(ctx)
}

// ReplyEmbedAttachment reply on message with embed message with attachment

func (ctx *Context) ReplyEmbedAttachmentImageURL(title, imageUrl string) *discordgo.Message {

	return NewEmbed(title).
		AttachImgURL(imageUrl).
		Footer(ctx.Loc("requested_by") + ": " + ctx.User.Username).
		Color(ctx.GetGuild().EmbedColor).
		Send(ctx)
}

1			package bot
2
3			import (
4			"fmt"
5			"io"
6
7			"github.com/bwmarrin/discordgo"
8			)
9
10			// NewEmbedStruct generated embed
11			type NewEmbedStruct struct {
12			*discordgo.MessageSend
13			embLength int
14			}
15
16			func truncateText(text string, length int) string {
17			if length > 3 && len(text) > length && len(text) > 3 {
18			text = text[:length-3] + "..."
19			}
20			return text
21			}
22
23			// NewEmbed creates new embed
24			func NewEmbed(title string) *NewEmbedStruct {
25			title = truncateText(title, 256)
26			return &NewEmbedStruct{&discordgo.MessageSend{Embed: &discordgo.MessageEmbed{Title: title}}, len(title)}
27			}
28
29			// CheckLength returns true if length of embed chars less then 6000
30			func (emb *NewEmbedStruct) CheckLength(newLength int) bool {
31			if emb.embLength + newLength <= 6000 {
32			return true
33			}
34			return false
35			}
36
37			// Field adds field to embed
38			func (emb NewEmbedStruct) Field(name, value string, inline bool) NewEmbedStruct {
39			if len(name) > 0 && len(value) > 0 {
40			name = truncateText(name, 256)
41			value = truncateText(value, 1024)
42			newLength := len(name + value)
43			if emb.CheckLength(newLength) {
44			emb.Embed.Fields = append(emb.Embed.Fields,
45			&discordgo.MessageEmbedField{
46			Name: name,
47			Value: value,
48			Inline: inline})
49			emb.embLength += newLength
50			}
51			}
52			return emb
53			}
54
55			// TimeStamp adds timestamp to footer of embed
56			func (emb NewEmbedStruct) TimeStamp(ts string) NewEmbedStruct {
57			emb.Embed.Timestamp = ts
58			return emb
59			}
60
61			// Author adds author to embed
62			func (emb NewEmbedStruct) Author(name, url, iconURL string) NewEmbedStruct {
63			name = truncateText(name, 256)
64			newLength := len(name)
65			if emb.CheckLength(newLength) {
66			emb.Embed.Author = &discordgo.MessageEmbedAuthor{URL: url, Name: name, IconURL: iconURL}
67			emb.embLength += newLength
68			}
69			return emb
70			}
71
72			// Desc adds description to embed
73			func (emb NewEmbedStruct) Desc(desc string) NewEmbedStruct {
74			desc = truncateText(desc, 2048)
75			newLength := len(desc)
76			if emb.CheckLength(newLength) {
77			emb.Embed.Description = desc
78			emb.embLength += newLength
79			}
80			return emb
81			}
82
83			// URL adds url to embed description
84			func (emb NewEmbedStruct) URL(url string) NewEmbedStruct {
85			emb.Embed.URL = url
86			return emb
87			}
88
89			// Footer adds footer text
90			func (emb NewEmbedStruct) Footer(text string) NewEmbedStruct {
91			text = truncateText(text, 2048)
92			newLength := len(text)
93			if emb.CheckLength(newLength) {
94			emb.Embed.Footer = &discordgo.MessageEmbedFooter{Text: text}
95			emb.embLength += newLength
96			}
97			return emb
98			}
99
100			// Color adds color to embed
101			func (emb NewEmbedStruct) Color(color int) NewEmbedStruct {
102			emb.Embed.Color = color
103			return emb
104			}
105
106			// AttachImg adds attached image to embed from io.Reader
107			func (emb NewEmbedStruct) AttachImg(name string, file io.Reader) NewEmbedStruct {
108			emb.Embed.Image = &discordgo.MessageEmbedImage{URL: "attachment://" + name}
109			emb.Files = append(emb.Files, &discordgo.File{Name: name, Reader: file})
110			return emb
111			}
112
113			// AttachImgURL adds attached image to embed from url
114			func (emb NewEmbedStruct) AttachImgURL(url string) NewEmbedStruct {
115			emb.Embed.Image = &discordgo.MessageEmbedImage{URL: url}
116			return emb
117			}
118
119			// AttachThumbURL adds attached thumbnail to embed from url
120			func (emb NewEmbedStruct) AttachThumbURL(url string) NewEmbedStruct {
121			emb.Embed.Thumbnail = &discordgo.MessageEmbedThumbnail{URL: url}
122			return emb
123			}
124
125			// Send send embed message to Discord
126			func (emb NewEmbedStruct) Send(ctx Context) *discordgo.Message {
127			msg, err := ctx.Discord.ChannelMessageSendComplex(ctx.TextChannel.ID, emb.MessageSend)
128			if err != nil {
129			fmt.Println("Error whilst sending embed message, ", err)
130			return nil
131			}
132			ctx.BotMsg.Add(ctx, msg.ID)
133			return msg
134			}
135
136			// SendPM send embed personal message to Discord
137			func (emb NewEmbedStruct) SendPM(ctx Context) *discordgo.Message {
138			ch, err := ctx.Discord.UserChannelCreate(ctx.User.ID)
139			if err != nil {
140			fmt.Println("Error whilst creating private channel, ", err)
141			return nil
142			}
143			msg, err := ctx.Discord.ChannelMessageSendComplex(ch.ID, emb.MessageSend)
144			if err != nil {
145			fmt.Println("Error whilst sending embed message, ", err)
146			return nil
147			}
148			return msg
149			}
150
151			// GetEmbed returns discords embed
152			func (emb NewEmbedStruct) GetEmbed() discordgo.MessageEmbed {
153			return emb.Embed
154			}
155
156			// Reply reply on massage
157			func (ctx Context) Reply(content string) discordgo.Message {
158			msg, err := ctx.Discord.ChannelMessageSend(ctx.TextChannel.ID, content)
159			if err != nil {
160			fmt.Println("Error whilst sending message,", err)
161			return nil
162			}
163			ctx.BotMsg.Add(ctx, msg.ID)
164			return msg
165			}
166
167			// ReplyFile reply on massage with file
168			func (ctx Context) ReplyFile(name string, r io.Reader) discordgo.Message {
169			msg, err := ctx.Discord.ChannelFileSend(ctx.TextChannel.ID, name, r)
170			if err != nil {
171			fmt.Println("Error whilst sending file,", err)
172			return nil
173			}
174			ctx.BotMsg.Add(ctx, msg.ID)
175			return msg
176			}
177
178			// EditEmbed edits embed message by id
179			func (ctx *Context) EditEmbed(ID, name, value string, inline bool) {
180			_, err := ctx.Discord.ChannelMessageEditEmbed(ctx.TextChannel.ID, ID, NewEmbed("").
181			Color(ctx.GetGuild().EmbedColor).
182			Footer(fmt.Sprintf("%v %v", ctx.Loc("requested_by"), ctx.User.Username)).
183			Field(name, value, inline).
184			GetEmbed())
185			if err != nil {
186			ctx.Log("Message", ctx.Guild.ID, err.Error())
187			}
188			}
189
190			// ReplyEmbed reply on message with embed message
191			func (ctx Context) ReplyEmbed(name, content string) discordgo.Message {
192			return NewEmbed("").
193			Field(name, content, false).
194			Footer(ctx.Loc("requested_by") + ": " + ctx.User.Username).
195			Color(ctx.GetGuild().EmbedColor).
196			Send(ctx)
197			}
198
199			// ReplyEmbedPM sends embed in personal channel
200			func (ctx Context) ReplyEmbedPM(name, content string) discordgo.Message {
201			return NewEmbed("").
202			Field(name, content, false).
203			Footer(ctx.Loc("requested_from") + ": " + ctx.Guild.Name).
204			Color(ctx.GetGuild().EmbedColor).
205			SendPM(ctx)
206			}
207
208			// ReplyPM sends reply message to user personal channel
209			func (ctx Context) ReplyPM(content string) discordgo.Message {
210			ch, err := ctx.Discord.UserChannelCreate(ctx.User.ID)
211			if err != nil {
212			ctx.Log("reply_pm", "", fmt.Sprintf("Error whilst creating private channel: %v", err.Error()))
213			return nil
214			}
215			msg, err := ctx.Discord.ChannelMessageSend(ch.ID, content)
216			if err != nil {
217			ctx.Log("reply_pm", "", fmt.Sprintf("ReplyPM error: %v", err.Error()))
218			}
219			return msg
220			}
221
222			// ReplyEmbedAttachment reply on message with embed message with attachment
223			func (ctx Context) ReplyEmbedAttachment(name, content, fileName string, file io.Reader) discordgo.Message {
224			return NewEmbed("").
225			Field(name, content, false).
226			AttachImg(fileName, file).
227			Footer(ctx.Loc("requested_by") + ": " + ctx.User.Username).
228			Color(ctx.GetGuild().EmbedColor).
229			Send(ctx)
230			}
231
232			// ReplyEmbedAttachment reply on message with embed message with attachment
			0 ignored issues – show introduced 2019-05-15 11:21 UTC by Report Bug Copy Issue Report comment on exported method Context.ReplyEmbedAttachmentImageURL should be of the form "ReplyEmbedAttachmentImageURL ..." Loading history...
233			func (ctx Context) ReplyEmbedAttachmentImageURL(title, imageUrl string) discordgo.Message {
			0 ignored issues – show introduced 2019-05-15 11:21 UTC by Report Bug Copy Issue Report method parameter imageUrl should be imageURL Loading history...
234			return NewEmbed(title).
235			AttachImgURL(imageUrl).
236			Footer(ctx.Loc("requested_by") + ": " + ctx.User.Username).
237			Color(ctx.GetGuild().EmbedColor).
238			Send(ctx)
239			}

FlameInTheDark / dtbot

Push — master ( a266ab...6dd3ac )

bot.*Context.ReplyEmbedAttachmentImageURL A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like