Merge pull request #42 from chelnak/format_update_message

Add UpdateMessagef() method

examples/advanced/main.go

@@ -49,8 +49,13 @@ func main() {
 }
 
 func downloader(wg *sync.WaitGroup, s *ysmrr.Spinner) {
-	s.UpdateMessage("Downloading...")
-	time.Sleep(2 * time.Second)
+	files := []string{"file1", "file2", "file3", "file4", "file5"}
+	for _, file := range files {
+		s.UpdateMessagef("Downloading %s...", file)
+		time.Sleep(1 * time.Second)
+	}
+
+	s.UpdateMessage("Downloading complete...")
 	s.Complete()
 }
 

spinner.go

@@ -38,6 +38,11 @@ func (s *Spinner) UpdateMessage(message string) {
 	s.notifyHasUpdate()
 }
 
+// UpdateMessagef updates the spinner message with a formatted string.
+func (s *Spinner) UpdateMessagef(format string, a ...interface{}) {
+	s.UpdateMessage(fmt.Sprintf(format, a...))
+}
+
 // IsComplete returns true if the spinner is complete.
 func (s *Spinner) IsComplete() bool {
 	s.mutex.Lock()

spinner_test.go

@@ -53,6 +53,14 @@ func TestSpinnerUpdateMessage(t *testing.T) {
 	assert.Equal(t, updatedMessage, spinner.GetMessage())
 }
 
+func TestSpinnerUpdateMessagef(t *testing.T) {
+	expectedMessage := "updated message test"
+	opts := initialOpts
+	spinner := ysmrr.NewSpinner(opts)
+	spinner.UpdateMessagef("updated message %s", "test")
+	assert.Equal(t, expectedMessage, spinner.GetMessage())
+}
+
 func TestSpinnerComplete(t *testing.T) {
 	opts := initialOpts
 	spinner := ysmrr.NewSpinner(opts)