kayos/girc-atomic
1
1
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Format -> Fmt, StripFormat -> TrimFmt

Browse Source
This commit is contained in:
Liam Stanley 2017-06-07 06:35:02 -04:00
parent 371ce2de16
commit 6c8215c842
4 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
client.go
View File

@ -113,8 +113,8 @@ type Config struct {
// messages. // messages.
AllowFlood bool AllowFlood bool
// GlobalFormat enables passing through all events which have trailing // GlobalFormat enables passing through all events which have trailing
// text through the color Format() function, so you don't have to wrap // text through the color Fmt() function, so you don't have to wrap
// every response in the Format() method. // every response in the Fmt() method.
// //
// Note that this only actually applies to PRIVMSG, NOTICE and TOPIC // Note that this only actually applies to PRIVMSG, NOTICE and TOPIC
// events, to ensure it doesn't clobber unwanted events. // events, to ensure it doesn't clobber unwanted events.

2
conn.go
View File

@ -395,7 +395,7 @@ func (c *Client) Send(event *Event) {
if c.Config.GlobalFormat && event.Trailing != "" && if c.Config.GlobalFormat && event.Trailing != "" &&
(event.Command == PRIVMSG || event.Command == TOPIC || event.Command == NOTICE) { (event.Command == PRIVMSG || event.Command == TOPIC || event.Command == NOTICE) {
event.Trailing = Format(event.Trailing) event.Trailing = Fmt(event.Trailing)
} }
c.write(event) c.write(event)

12
format.go
View File

@ -40,13 +40,13 @@ var codes = []*ircFmtCode{
{aliases: []string{"ctcp"}, val: "\x01"}, // CTCP/ACTION delimiter. {aliases: []string{"ctcp"}, val: "\x01"}, // CTCP/ACTION delimiter.
} }
// Format takes format strings like "{red}" and turns them into the resulting // Fmt takes format strings like "{red}" and turns them into the resulting
// ASCII format/color codes for IRC. // ASCII format/color codes for IRC.
// //
// For example: // For example:
// //
// client.Message("#channel", Format("{red}{bold}Hello World{c}")) // client.Message("#channel", Fmt("{red}{bold}Hello World{c}"))
func Format(text string) string { func Fmt(text string) string {
for i := 0; i < len(codes); i++ { for i := 0; i < len(codes); i++ {
for a := 0; a < len(codes[i].aliases); a++ { for a := 0; a < len(codes[i].aliases); a++ {
text = strings.Replace(text, "{"+codes[i].aliases[a]+"}", codes[i].val, -1) text = strings.Replace(text, "{"+codes[i].aliases[a]+"}", codes[i].val, -1)
@ -69,9 +69,9 @@ func Format(text string) string {
return text return text
} }
// StripFormat strips all "{fmt}" formatting strings from the input text. // TrimFmt strips all "{fmt}" formatting strings from the input text.
// See Format() for more information. // See Fmt() for more information.
func StripFormat(text string) string { func TrimFmt(text string) string {
for i := 0; i < len(codes); i++ { for i := 0; i < len(codes); i++ {
for a := 0; a < len(codes[i].aliases); a++ { for a := 0; a < len(codes[i].aliases); a++ {
text = strings.Replace(text, "{"+codes[i].aliases[a]+"}", "", -1) text = strings.Replace(text, "{"+codes[i].aliases[a]+"}", "", -1)

18
format_test.go
View File

@ -11,7 +11,7 @@ import (
func BenchmarkFormat(b *testing.B) { func BenchmarkFormat(b *testing.B) {
for i := 0; i < b.N; i++ { for i := 0; i < b.N; i++ {
Format("{red}test{c}") Fmt("{red}test{c}")
} }
return return
@ -19,7 +19,7 @@ func BenchmarkFormat(b *testing.B) {
func BenchmarkFormatLong(b *testing.B) { func BenchmarkFormatLong(b *testing.B) {
for i := 0; i < b.N; i++ { for i := 0; i < b.N; i++ {
Format("{red}test {blue}2 {red}3 {brown} {italic}test{c}") Fmt("{red}test {blue}2 {red}3 {brown} {italic}test{c}")
} }
return return
@ -27,7 +27,7 @@ func BenchmarkFormatLong(b *testing.B) {
func BenchmarkStripFormat(b *testing.B) { func BenchmarkStripFormat(b *testing.B) {
for i := 0; i < b.N; i++ { for i := 0; i < b.N; i++ {
StripFormat("{red}test{c}") TrimFmt("{red}test{c}")
} }
return return
@ -35,14 +35,14 @@ func BenchmarkStripFormat(b *testing.B) {
func BenchmarkStripFormatLong(b *testing.B) { func BenchmarkStripFormatLong(b *testing.B) {
for i := 0; i < b.N; i++ { for i := 0; i < b.N; i++ {
StripFormat("{red}test {blue}2 {red}3 {brown} {italic}test{c}") TrimFmt("{red}test {blue}2 {red}3 {brown} {italic}test{c}")
} }
return return
} }
func BenchmarkStripRaw(b *testing.B) { func BenchmarkStripRaw(b *testing.B) {
text := Format("{red}test{c}") text := Fmt("{red}test{c}")
for i := 0; i < b.N; i++ { for i := 0; i < b.N; i++ {
StripRaw(text) StripRaw(text)
} }
@ -51,7 +51,7 @@ func BenchmarkStripRaw(b *testing.B) {
} }
func BenchmarkStripRawLong(b *testing.B) { func BenchmarkStripRawLong(b *testing.B) {
text := Format("{red}test {blue}2 {red}3 {brown} {italic}test{c}") text := Fmt("{red}test {blue}2 {red}3 {brown} {italic}test{c}")
for i := 0; i < b.N; i++ { for i := 0; i < b.N; i++ {
StripRaw(text) StripRaw(text)
} }
@ -77,7 +77,7 @@ func TestFormat(t *testing.T) {
} }
for _, tt := range tests { for _, tt := range tests {
if got := Format(tt.args.text); got != tt.want { if got := Fmt(tt.args.text); got != tt.want {
t.Errorf("%s: Format() = %v, want %v", tt.name, got, tt.want) t.Errorf("%s: Format() = %v, want %v", tt.name, got, tt.want)
} }
} }
@ -101,7 +101,7 @@ func TestStripFormat(t *testing.T) {
} }
for _, tt := range tests { for _, tt := range tests {
if got := StripFormat(tt.args.text); got != tt.want { if got := TrimFmt(tt.args.text); got != tt.want {
t.Errorf("%s: StripFormat() = %v, want %v", tt.name, got, tt.want) t.Errorf("%s: StripFormat() = %v, want %v", tt.name, got, tt.want)
} }
} }
@ -125,7 +125,7 @@ func TestStripRaw(t *testing.T) {
} }
for _, tt := range tests { for _, tt := range tests {
if got := StripRaw(Format(tt.args.text)); got != tt.want { if got := StripRaw(Fmt(tt.args.text)); got != tt.want {
t.Errorf("%s: StripRaw() = %v, want %v", tt.name, got, tt.want) t.Errorf("%s: StripRaw() = %v, want %v", tt.name, got, tt.want)
} }
} }