[WIP] Refactoring towards v2.0

.gitignore

@@ -1,4 +1,5 @@
 /build
+/vendor
 host_key
 host_key.pub
 ssh-chat

chat/command.go

@@ -5,6 +5,7 @@ package chat
 import (
 	"errors"
 	"fmt"
+	"io"
 	"strings"
 
 	"github.com/shazow/ssh-chat/chat/message"
@@ -24,6 +25,10 @@ var ErrMissingArg = errors.New("missing argument")
 // The error returned when a command is added without a prefix.
 var ErrMissingPrefix = errors.New("command missing prefix")
 
+// The error returned when we fail to find a corresponding userMember struct
+// for an ID. This should not happen, probably a bug somewhere if encountered.
+var ErrMissingMember = errors.New("failed to find member")
+
 // Command is a definition of a handler for a command.
 type Command struct {
 	// The command's key, such as /foo
@@ -131,8 +136,7 @@ func InitCommands(c *Commands) {
 		Prefix: "/exit",
 		Help:   "Exit the chat.",
 		Handler: func(room *Room, msg message.CommandMsg) error {
-			msg.From().Close()
-			return nil
+			return msg.From().(io.Closer).Close()
 		},
 	})
 	c.Alias("/exit", "/quit")
@@ -146,18 +150,16 @@ func InitCommands(c *Commands) {
 			if len(args) != 1 {
 				return ErrMissingArg
 			}
-			u := msg.From()
-
-			member, ok := room.MemberByID(u.ID())
+			member, ok := room.MemberByID(msg.From().ID())
 			if !ok {
-				return errors.New("failed to find member")
+				return ErrMissingMember
 			}
 
 			oldID := member.ID()
-			member.SetID(SanitizeName(args[0]))
+			member.SetName(args[0])
 			err := room.Rename(oldID, member)
 			if err != nil {
-				member.SetID(oldID)
+				member.SetName(oldID)
 				return err
 			}
 			return nil
@@ -182,7 +184,7 @@ func InitCommands(c *Commands) {
 		PrefixHelp: "[colors|...]",
 		Help:       "Set your color theme. (More themes: solarized, mono, hacker)",
 		Handler: func(room *Room, msg message.CommandMsg) error {
-			user := msg.From()
+			user := msg.From().(Member)
 			args := msg.Args()
 			cfg := user.Config()
 			if len(args) == 0 {
@@ -213,7 +215,7 @@ func InitCommands(c *Commands) {
 		Prefix: "/quiet",
 		Help:   "Silence room announcements.",
 		Handler: func(room *Room, msg message.CommandMsg) error {
-			u := msg.From()
+			u := msg.From().(Member)
 			cfg := u.Config()
 			cfg.Quiet = !cfg.Quiet
 			u.SetConfig(cfg)
@@ -251,11 +253,16 @@ func InitCommands(c *Commands) {
 		PrefixHelp: "[USER]",
 		Help:       "Hide messages from USER, /unignore USER to stop hiding.",
 		Handler: func(room *Room, msg message.CommandMsg) error {
+			from, ok := room.Member(msg.From())
+			if !ok {
+				return ErrMissingMember
+			}
+
 			id := strings.TrimSpace(strings.TrimLeft(msg.Body(), "/ignore"))
 			if id == "" {
 				// Print ignored names, if any.
 				var names []string
-				msg.From().Ignored.Each(func(_ string, item set.Item) error {
+				from.Ignored.Each(func(_ string, item set.Item) error {
 					names = append(names, item.Key())
 					return nil
 				})
@@ -279,7 +286,7 @@ func InitCommands(c *Commands) {
 				return fmt.Errorf("user not found: %s", id)
 			}
 
-			err := msg.From().Ignored.Add(set.Itemize(id, target))
+			err := from.Ignored.Add(set.Itemize(id, target))
 			if err == set.ErrCollision {
 				return fmt.Errorf("user already ignored: %s", id)
 			} else if err != nil {
@@ -295,12 +302,16 @@ func InitCommands(c *Commands) {
 		Prefix:     "/unignore",
 		PrefixHelp: "USER",
 		Handler: func(room *Room, msg message.CommandMsg) error {
+			from, ok := room.Member(msg.From())
+			if !ok {
+				return ErrMissingMember
+			}
 			id := strings.TrimSpace(strings.TrimLeft(msg.Body(), "/unignore"))
 			if id == "" {
 				return errors.New("must specify user")
 			}
 
-			if err := msg.From().Ignored.Remove(id); err != nil {
+			if err := from.Ignored.Remove(id); err != nil {
 				return err
 			}
 

chat/member.go

@@ -0,0 +1,23 @@
+package chat
+
+import (
+	"github.com/shazow/ssh-chat/chat/message"
+	"github.com/shazow/ssh-chat/set"
+)
+
+// Member is a User with per-Room metadata attached to it.
+type roomMember struct {
+	Member
+	Ignored *set.Set
+}
+
+type Member interface {
+	message.Author
+
+	Config() message.UserConfig
+	SetConfig(message.UserConfig)
+
+	Send(message.Message) error
+
+	SetName(string)
+}

chat/message/config.go

@@ -0,0 +1,24 @@
+package message
+
+import "regexp"
+
+// Container for per-user configurations.
+type UserConfig struct {
+	Highlight *regexp.Regexp
+	Bell      bool
+	Quiet     bool
+	Theme     *Theme
+	Seed      int
+}
+
+// Default user configuration to use
+var DefaultUserConfig UserConfig
+
+func init() {
+	DefaultUserConfig = UserConfig{
+		Bell:  true,
+		Quiet: false,
+	}
+
+	// TODO: Seed random?
+}

chat/message/message.go

@@ -6,6 +6,12 @@ import (
 	"time"
 )
 
+type Author interface {
+	ID() string
+	Name() string
+	Color() int
+}
+
 // Message is an interface for messages.
 type Message interface {
 	Render(*Theme) string
@@ -16,15 +22,15 @@ type Message interface {
 
 type MessageTo interface {
 	Message
-	To() *User
+	To() Author
 }
 
 type MessageFrom interface {
 	Message
-	From() *User
+	From() Author
 }
 
-func ParseInput(body string, from *User) Message {
+func ParseInput(body string, from Author) Message {
 	m := NewPublicMsg(body, from)
 	cmd, isCmd := m.ParseCommand()
 	if isCmd {
@@ -69,10 +75,10 @@ func (m Msg) Timestamp() time.Time {
 // PublicMsg is any message from a user sent to the room.
 type PublicMsg struct {
 	Msg
-	from *User
+	from Author
 }
 
-func NewPublicMsg(body string, from *User) PublicMsg {
+func NewPublicMsg(body string, from Author) PublicMsg {
 	return PublicMsg{
 		Msg: Msg{
 			body:      body,
@@ -82,7 +88,7 @@ func NewPublicMsg(body string, from *User) PublicMsg {
 	}
 }
 
-func (m PublicMsg) From() *User {
+func (m PublicMsg) From() Author {
 	return m.from
 }
 
@@ -137,10 +143,10 @@ func (m PublicMsg) String() string {
 // sender to see the emote.
 type EmoteMsg struct {
 	Msg
-	from *User
+	from Author
 }
 
-func NewEmoteMsg(body string, from *User) *EmoteMsg {
+func NewEmoteMsg(body string, from Author) *EmoteMsg {
 	return &EmoteMsg{
 		Msg: Msg{
 			body:      body,
@@ -161,17 +167,17 @@ func (m EmoteMsg) String() string {
 // PrivateMsg is a message sent to another user, not shown to anyone else.
 type PrivateMsg struct {
 	PublicMsg
-	to *User
+	to Author
 }
 
-func NewPrivateMsg(body string, from *User, to *User) PrivateMsg {
+func NewPrivateMsg(body string, from Author, to Author) PrivateMsg {
 	return PrivateMsg{
 		PublicMsg: NewPublicMsg(body, from),
 		to:        to,
 	}
 }
 
-func (m PrivateMsg) To() *User {
+func (m PrivateMsg) To() Author {
 	return m.to
 }
 
@@ -191,10 +197,10 @@ func (m PrivateMsg) String() string {
 // to anyone else. Usually in response to something, like /help.
 type SystemMsg struct {
 	Msg
-	to *User
+	to Author
 }
 
-func NewSystemMsg(body string, to *User) *SystemMsg {
+func NewSystemMsg(body string, to Author) *SystemMsg {
 	return &SystemMsg{
 		Msg: Msg{
 			body:      body,
@@ -215,7 +221,7 @@ func (m *SystemMsg) String() string {
 	return fmt.Sprintf("-> %s", m.body)
 }
 
-func (m *SystemMsg) To() *User {
+func (m *SystemMsg) To() Author {
 	return m.to
 }
 

chat/message/message_test.go

@@ -11,7 +11,7 @@ func TestMessage(t *testing.T) {
 		t.Errorf("Got: `%s`; Expected: `%s`", actual, expected)
 	}
 
-	u := NewUser(SimpleID("foo"))
+	u := NewUser("foo")
 	expected = "foo: hello"
 	actual = NewPublicMsg("hello", u).String()
 	if actual != expected {

chat/sanitize.go → chat/message/sanitize.go

@@ -1,8 +1,9 @@
-package chat
+package message
 
 import "regexp"
 
 var reStripName = regexp.MustCompile("[^\\w.-]")
+
 const maxLength = 16
 
 // SanitizeName returns a name with only allowed characters and a reasonable length
@@ -15,10 +16,3 @@ func SanitizeName(s string) string {
 	s = s[:nameLength]
 	return s
 }
-
-var reStripData = regexp.MustCompile("[^[:ascii:]]")
-
-// SanitizeData returns a string with only allowed characters for client-provided metadata inputs.
-func SanitizeData(s string) string {
-	return reStripData.ReplaceAllString(s, "")
-}