add progress ui component WIP

Author: dGilli

go.mod

@@ -7,5 +7,7 @@ require github.com/stretchr/testify v1.9.0
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	golang.org/x/sys v0.22.0 // indirect
+	golang.org/x/term v0.22.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -4,6 +4,10 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+golang.org/x/sys v0.22.0 h1:RI27ohtqKCnwULzJLqkv897zojh5/DwS/ENaMzUOaWI=
+golang.org/x/sys v0.22.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/term v0.22.0 h1:BbsgPEJULsl2fV/AT3v15Mjva5yXKQDyKf+TbDz7QJk=
+golang.org/x/term v0.22.0/go.mod h1:F3qCibpT5AMpCRfhfT53vVJwhLtIVHhB9XDjfFvnMI4=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

progress/example/main.go

@@ -0,0 +1,21 @@
+package main
+
+import (
+	"log"
+	"time"
+
+	"github.com/dGilli/terminal-ui/progress"
+)
+
+func main() {
+	p := progress.New(progress.Config{})
+
+	log.Println("Starting the progress bar")
+
+	p.Update(50)
+
+	time.Sleep(time.Second * 1)
+	p.Update(100)
+
+	log.Println("Progress complete")
+}

progress/progress.go

@@ -0,0 +1,150 @@
+package progress
+
+import (
+	"context"
+	"io"
+	"math"
+	"os"
+	"sync"
+	"time"
+
+	"golang.org/x/term"
+)
+
+type Progress struct {
+	writer     io.Writer
+	glyph      rune
+    cols       int
+    current    int
+	cancelFunc context.CancelFunc
+	doneCh     chan struct{}
+	lock       sync.RWMutex
+}
+
+type Config struct {
+	Writer io.Writer
+	Glyph  *rune
+    Cols   *int
+}
+
+func New(cfg Config) *Progress {
+	p := &Progress{
+		writer: os.Stderr,
+		glyph:  '#',
+        cols:   80,
+	}
+
+	if cfg.Writer != nil {
+		p.writer = cfg.Writer
+	}
+
+	if cfg.Glyph != nil {
+		p.glyph = *cfg.Glyph
+	}
+
+	if cfg.Cols != nil {
+		p.cols = *cfg.Cols
+	} else if term.IsTerminal(0) {
+        width, _, err := term.GetSize(0)
+        if err == nil {
+            p.cols = width
+        }
+    }
+
+	return p
+}
+
+type Bar struct {
+    cols int32
+}
+
+func (b *Bar) Update(current float64) {
+    numGlyphs := int(math.Floor(current * float64(b.cols / 100)))
+
+    ticker := time.NewTicker(500 * time.Millisecond)
+	done := make(chan bool)
+
+	go func() {
+		time.Sleep(5 * time.Second)
+		done <- true
+	}()
+
+	for {
+		select {
+		case t := <-ticker.C:
+            p.writer.Write([]byte("#"))
+		case <-done:
+			ticker.Stop()
+			return
+		}
+	}
+
+    for i := 0; i < numGlyphs; i++ {
+        b.writer.Write([]byte("#"))
+	    time.Sleep(time.Millisecond * 100)
+        if i == 10 {
+            p.writer.Write([]byte("\n"))
+        }
+    }
+}
+
+func (p *Progress) Update(current int) {
+
+    /*
+	if p.isComplete() {
+		return
+	}
+
+    complete := 80
+    if current > complete {
+		current = complete
+	}
+
+	p.current = current
+    */
+
+    //repeatedRune := strings.Repeat(string(p.glyph), current / 100 * 80)
+
+    /*
+    for i := 0; i < 10; i++ {
+        p.writer.Write([]byte("#"))
+	    time.Sleep(time.Millisecond * 100)
+        if i == 10 {
+            p.writer.Write([]byte("\n"))
+        }
+    }
+    p.writer.Write([]byte("\n"))
+*/
+
+    /*
+######################################################### / 100%
+    */
+
+    ticker := time.NewTicker(1 * time.Second)
+	done := make(chan bool)
+
+	go func() {
+		time.Sleep(5 * time.Second)
+		done <- true
+	}()
+
+	for {
+		select {
+		case t := <-ticker.C:
+            p.writer.Write([]byte("#"))
+		case <-done:
+			ticker.Stop()
+			return
+		}
+	}
+
+    //repeatedRune := strings.Repeat(string(p.glyph), 10)
+    //p.writer.Write([]byte(repeatedRune))
+}
+
+func (p *Progress) isComplete() bool {
+	p.lock.RLock()
+	defer p.lock.RUnlock()
+
+	return p.doneCh != nil
+}

progress/progress_test.go

@@ -0,0 +1,63 @@
+package progress_test
+
+import (
+	"bytes"
+	"io"
+	"strings"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+
+	"github.com/dGilli/terminal-ui/progress"
+)
+
+func TestProgressUpdate(t *testing.T) {
+	testCases := []struct {
+		name     string
+        progress int
+        expects  int // progress bar length relative to terminal wdith
+	}{
+        {
+            name:     "should update progress correctly",
+            progress: 50,
+            expects:  50,
+        },
+        {
+            name:     "should complete correctly",
+            progress: 100,
+            expects:  100,
+        },
+        {
+            name:     "should clamp progress to total",
+            progress: 150,
+            expects:  100,
+        },
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			buf := &bytes.Buffer{}
+
+			p := progress.New(progress.Config{
+				Writer: buf,
+                Width: 100,
+			})
+
+            p.Update(tc.progress)
+
+			time.Sleep(time.Second * 1)
+
+			data, err := io.ReadAll(buf)
+			assert.NoError(t, err)
+
+			assert.Equal(t, strings.Repeat("#", tc.expects), string(data))
+		})
+	}
+}
+
+func TestProgressWorksAsync(t *testing.T) {
+}
+
+func TestAdjustsToTerminalSize(t *testing.T) {
+}