Skip to content

Commit d950112

Browse files
committed
refactor: Id -> ID
1 parent 0fcc076 commit d950112

File tree

13 files changed

+64
-64
lines changed

13 files changed

+64
-64
lines changed

chat/command.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -148,16 +148,16 @@ func InitCommands(c *Commands) {
148148
}
149149
u := msg.From()
150150

151-
member, ok := room.MemberById(u.Id())
151+
member, ok := room.MemberByID(u.ID())
152152
if !ok {
153153
return errors.New("failed to find member")
154154
}
155155

156-
oldId := member.Id()
157-
member.SetId(SanitizeName(args[0]))
158-
err := room.Rename(oldId, member)
156+
oldID := member.ID()
157+
member.SetID(SanitizeName(args[0]))
158+
err := room.Rename(oldID, member)
159159
if err != nil {
160-
member.SetId(oldId)
160+
member.SetID(oldID)
161161
return err
162162
}
163163
return nil
@@ -187,7 +187,7 @@ func InitCommands(c *Commands) {
187187
if len(args) == 0 {
188188
theme := "plain"
189189
if user.Config.Theme != nil {
190-
theme = user.Config.Theme.Id()
190+
theme = user.Config.Theme.ID()
191191
}
192192
body := fmt.Sprintf("Current theme: %s", theme)
193193
room.Send(message.NewSystemMsg(body, user))
@@ -196,7 +196,7 @@ func InitCommands(c *Commands) {
196196

197197
id := args[0]
198198
for _, t := range message.Themes {
199-
if t.Id() == id {
199+
if t.ID() == id {
200200
user.Config.Theme = &t
201201
body := fmt.Sprintf("Set theme: %s", id)
202202
room.Send(message.NewSystemMsg(body, user))
@@ -266,7 +266,7 @@ func InitCommands(c *Commands) {
266266
return nil
267267
}
268268

269-
target, ok := room.MemberById(id)
269+
target, ok := room.MemberByID(id)
270270
if !ok {
271271
return fmt.Errorf("user %s not found.", id)
272272
}

chat/message/identity.go

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@ package message
22

33
// Identifier is an interface that can uniquely identify itself.
44
type Identifier interface {
5-
Id() string
6-
SetId(string)
5+
ID() string
6+
SetID(string)
77
Name() string
88
}
99

10-
// SimpleId is a simple Identifier implementation used for testing.
11-
type SimpleId string
10+
// SimpleID is a simple Identifier implementation used for testing.
11+
type SimpleID string
1212

13-
// Id returns the Id as a string.
14-
func (i SimpleId) Id() string {
13+
// ID returns the ID as a string.
14+
func (i SimpleID) ID() string {
1515
return string(i)
1616
}
1717

18-
// SetId is a no-op
19-
func (i SimpleId) SetId(s string) {
18+
// SetID is a no-op
19+
func (i SimpleID) SetID(s string) {
2020
// no-op
2121
}
2222

23-
// Name returns the Id
24-
func (i SimpleId) Name() string {
25-
return i.Id()
23+
// Name returns the ID
24+
func (i SimpleID) Name() string {
25+
return i.ID()
2626
}

chat/message/message_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ func TestMessage(t *testing.T) {
1111
t.Errorf("Got: `%s`; Expected: `%s`", actual, expected)
1212
}
1313

14-
u := NewUser(SimpleId("foo"))
14+
u := NewUser(SimpleID("foo"))
1515
expected = "foo: hello"
1616
actual = NewPublicMsg("hello", u).String()
1717
if actual != expected {

chat/message/theme.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ type Theme struct {
122122
names *Palette
123123
}
124124

125-
func (t Theme) Id() string {
125+
func (t Theme) ID() string {
126126
return t.id
127127
}
128128

@@ -233,7 +233,7 @@ func init() {
233233
}
234234

235235
func printTheme(t Theme) {
236-
fmt.Println("Printing theme:", t.Id())
236+
fmt.Println("Printing theme:", t.ID())
237237
if t.names != nil {
238238
for i, color := range t.names.colors {
239239
fmt.Printf("%s ", color.Format(fmt.Sprintf("name%d", i)))

chat/message/theme_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ func TestTheme(t *testing.T) {
5151
t.Errorf("Got: %q; Expected: %q", actual, expected)
5252
}
5353

54-
u := NewUser(SimpleId("foo"))
54+
u := NewUser(SimpleID("foo"))
5555
u.colorIdx = 4
5656
actual = colorTheme.ColorName(u)
5757
expected = "\033[38;05;5mfoo\033[0m"

chat/message/user.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ func NewUserScreen(identity Identifier, screen io.WriteCloser) *User {
5757
}
5858

5959
// Rename the user with a new Identifier.
60-
func (u *User) SetId(id string) {
61-
u.Identifier.SetId(id)
60+
func (u *User) SetID(id string) {
61+
u.Identifier.SetID(id)
6262
u.SetColorIdx(rand.Int())
6363
}
6464

@@ -194,15 +194,15 @@ func (u *User) Ignore(other Identifier) error {
194194
return errors.New("user is nil.")
195195
}
196196

197-
if other.Id() == u.Id() {
197+
if other.ID() == u.ID() {
198198
return errors.New("cannot ignore self.")
199199
}
200200

201-
if u.Ignored.In(other.Id()) {
201+
if u.Ignored.In(other.ID()) {
202202
return errors.New("user already ignored.")
203203
}
204204

205-
u.Ignored.Add(set.Itemize(other.Id(), other))
205+
u.Ignored.Add(set.Itemize(other.ID(), other))
206206
return nil
207207
}
208208

chat/message/user_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ func TestMakeUser(t *testing.T) {
99
var actual, expected []byte
1010

1111
s := &MockScreen{}
12-
u := NewUserScreen(SimpleId("foo"), s)
12+
u := NewUserScreen(SimpleID("foo"), s)
1313
m := NewAnnounceMsg("hello")
1414

1515
defer u.Close()

chat/room.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ func (r *Room) HandleMsg(m message.Message) {
100100
r.Members.Each(func(_ string, item set.Item) (err error) {
101101
user := item.Value().(*Member).User
102102

103-
if fromMsg != nil && user.Ignored.In(fromMsg.From().Id()) {
103+
if fromMsg != nil && user.Ignored.In(fromMsg.From().ID()) {
104104
// Skip because ignored
105105
return
106106
}
@@ -144,11 +144,11 @@ func (r *Room) History(u *message.User) {
144144
// Join the room as a user, will announce.
145145
func (r *Room) Join(u *message.User) (*Member, error) {
146146
// TODO: Check if closed
147-
if u.Id() == "" {
147+
if u.ID() == "" {
148148
return nil, ErrInvalidName
149149
}
150150
member := &Member{u}
151-
err := r.Members.Add(set.Itemize(u.Id(), member))
151+
err := r.Members.Add(set.Itemize(u.ID(), member))
152152
if err != nil {
153153
return nil, err
154154
}
@@ -160,35 +160,35 @@ func (r *Room) Join(u *message.User) (*Member, error) {
160160

161161
// Leave the room as a user, will announce. Mostly used during setup.
162162
func (r *Room) Leave(u message.Identifier) error {
163-
err := r.Members.Remove(u.Id())
163+
err := r.Members.Remove(u.ID())
164164
if err != nil {
165165
return err
166166
}
167-
r.Ops.Remove(u.Id())
167+
r.Ops.Remove(u.ID())
168168
s := fmt.Sprintf("%s left.", u.Name())
169169
r.Send(message.NewAnnounceMsg(s))
170170
return nil
171171
}
172172

173173
// Rename member with a new identity. This will not call rename on the member.
174-
func (r *Room) Rename(oldId string, u message.Identifier) error {
175-
if u.Id() == "" {
174+
func (r *Room) Rename(oldID string, u message.Identifier) error {
175+
if u.ID() == "" {
176176
return ErrInvalidName
177177
}
178-
err := r.Members.Replace(oldId, set.Itemize(u.Id(), u))
178+
err := r.Members.Replace(oldID, set.Itemize(u.ID(), u))
179179
if err != nil {
180180
return err
181181
}
182182

183-
s := fmt.Sprintf("%s is now known as %s.", oldId, u.Id())
183+
s := fmt.Sprintf("%s is now known as %s.", oldID, u.ID())
184184
r.Send(message.NewAnnounceMsg(s))
185185
return nil
186186
}
187187

188188
// Member returns a corresponding Member object to a User if the Member is
189189
// present in this room.
190190
func (r *Room) Member(u *message.User) (*Member, bool) {
191-
m, ok := r.MemberById(u.Id())
191+
m, ok := r.MemberByID(u.ID())
192192
if !ok {
193193
return nil, false
194194
}
@@ -199,7 +199,7 @@ func (r *Room) Member(u *message.User) (*Member, bool) {
199199
return m, true
200200
}
201201

202-
func (r *Room) MemberById(id string) (*Member, bool) {
202+
func (r *Room) MemberByID(id string) (*Member, bool) {
203203
m, err := r.Members.Get(id)
204204
if err != nil {
205205
return nil, false
@@ -209,7 +209,7 @@ func (r *Room) MemberById(id string) (*Member, bool) {
209209

210210
// IsOp returns whether a user is an operator in this room.
211211
func (r *Room) IsOp(u *message.User) bool {
212-
return r.Ops.In(u.Id())
212+
return r.Ops.In(u.ID())
213213
}
214214

215215
// Topic of the room.

chat/room_test.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ func TestIgnore(t *testing.T) {
5959
users := make([]ScreenedUser, 3)
6060
for i := 0; i < 3; i++ {
6161
screen := &MockScreen{}
62-
user := message.NewUserScreen(message.SimpleId(fmt.Sprintf("user%d", i)), screen)
62+
user := message.NewUserScreen(message.SimpleID(fmt.Sprintf("user%d", i)), screen)
6363
users[i] = ScreenedUser{
6464
user: user,
6565
screen: screen,
@@ -176,7 +176,7 @@ func TestRoomJoin(t *testing.T) {
176176
var expected, actual []byte
177177

178178
s := &MockScreen{}
179-
u := message.NewUserScreen(message.SimpleId("foo"), s)
179+
u := message.NewUserScreen(message.SimpleID("foo"), s)
180180

181181
ch := NewRoom()
182182
go ch.Serve()
@@ -212,7 +212,7 @@ func TestRoomJoin(t *testing.T) {
212212
}
213213

214214
func TestRoomDoesntBroadcastAnnounceMessagesWhenQuiet(t *testing.T) {
215-
u := message.NewUser(message.SimpleId("foo"))
215+
u := message.NewUser(message.SimpleID("foo"))
216216
u.Config = message.UserConfig{
217217
Quiet: true,
218218
}
@@ -251,7 +251,7 @@ func TestRoomDoesntBroadcastAnnounceMessagesWhenQuiet(t *testing.T) {
251251
}
252252

253253
func TestRoomQuietToggleBroadcasts(t *testing.T) {
254-
u := message.NewUser(message.SimpleId("foo"))
254+
u := message.NewUser(message.SimpleID("foo"))
255255
u.Config = message.UserConfig{
256256
Quiet: true,
257257
}
@@ -290,7 +290,7 @@ func TestQuietToggleDisplayState(t *testing.T) {
290290
var expected, actual []byte
291291

292292
s := &MockScreen{}
293-
u := message.NewUserScreen(message.SimpleId("foo"), s)
293+
u := message.NewUserScreen(message.SimpleID("foo"), s)
294294

295295
ch := NewRoom()
296296
go ch.Serve()
@@ -331,7 +331,7 @@ func TestRoomNames(t *testing.T) {
331331
var expected, actual []byte
332332

333333
s := &MockScreen{}
334-
u := message.NewUserScreen(message.SimpleId("foo"), s)
334+
u := message.NewUserScreen(message.SimpleID("foo"), s)
335335

336336
ch := NewRoom()
337337
go ch.Serve()

chat/set_test.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,28 +10,28 @@ import (
1010
func TestSet(t *testing.T) {
1111
var err error
1212
s := set.New()
13-
u := message.NewUser(message.SimpleId("foo"))
13+
u := message.NewUser(message.SimpleID("foo"))
1414

15-
if s.In(u.Id()) {
15+
if s.In(u.ID()) {
1616
t.Errorf("Set should be empty.")
1717
}
1818

19-
err = s.Add(set.Itemize(u.Id(), u))
19+
err = s.Add(set.Itemize(u.ID(), u))
2020
if err != nil {
2121
t.Error(err)
2222
}
2323

24-
if !s.In(u.Id()) {
24+
if !s.In(u.ID()) {
2525
t.Errorf("Set should contain user.")
2626
}
2727

28-
u2 := message.NewUser(message.SimpleId("bar"))
29-
err = s.Add(set.Itemize(u2.Id(), u2))
28+
u2 := message.NewUser(message.SimpleID("bar"))
29+
err = s.Add(set.Itemize(u2.ID(), u2))
3030
if err != nil {
3131
t.Error(err)
3232
}
3333

34-
err = s.Add(set.Itemize(u2.Id(), u2))
34+
err = s.Add(set.Itemize(u2.ID(), u2))
3535
if err != set.ErrCollision {
3636
t.Error(err)
3737
}

0 commit comments

Comments
 (0)