Initial skeleton of Bubbletea structs

Readme.md

@@ -1,3 +1,14 @@
 # Pingo - a simple ping visualizer written in go
 
 to run the project, simply `go run .`
+
+## TODO:
+
+### Core
+ - [ ] Implement Bubbletea framework
+ - [ ] Implement lipgloss styling
+ - [ ] Implement bubbles widgets (where applicable)
+ - [ ] Implement ntcharts framework for tables
+
+### Extras
+ - [ ] Implement ssh TUI client (via wish)

go.mod

@@ -1,3 +1,26 @@
 module pingo
 
 go 1.25.6
+
+require github.com/charmbracelet/bubbletea v1.3.10
+
+require (
+	github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
+	github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc // indirect
+	github.com/charmbracelet/lipgloss v1.1.0 // indirect
+	github.com/charmbracelet/x/ansi v0.10.1 // indirect
+	github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd // indirect
+	github.com/charmbracelet/x/term v0.2.1 // indirect
+	github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f // indirect
+	github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mattn/go-localereader v0.0.1 // indirect
+	github.com/mattn/go-runewidth v0.0.16 // indirect
+	github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 // indirect
+	github.com/muesli/cancelreader v0.2.2 // indirect
+	github.com/muesli/termenv v0.16.0 // indirect
+	github.com/rivo/uniseg v0.4.7 // indirect
+	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
+	golang.org/x/sys v0.36.0 // indirect
+	golang.org/x/text v0.3.8 // indirect
+)

go.sum

@@ -0,0 +1,43 @@
+github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
+github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
+github.com/charmbracelet/bubbletea v1.3.10 h1:otUDHWMMzQSB0Pkc87rm691KZ3SWa4KUlvF9nRvCICw=
+github.com/charmbracelet/bubbletea v1.3.10/go.mod h1:ORQfo0fk8U+po9VaNvnV95UPWA1BitP1E0N6xJPlHr4=
+github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc h1:4pZI35227imm7yK2bGPcfpFEmuY1gc2YSTShr4iJBfs=
+github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc/go.mod h1:X4/0JoqgTIPSFcRA/P6INZzIuyqdFY5rm8tb41s9okk=
+github.com/charmbracelet/lipgloss v1.1.0 h1:vYXsiLHVkK7fp74RkV7b2kq9+zDLoEU4MZoFqR/noCY=
+github.com/charmbracelet/lipgloss v1.1.0/go.mod h1:/6Q8FR2o+kj8rz4Dq0zQc3vYf7X+B0binUUBwA0aL30=
+github.com/charmbracelet/x/ansi v0.10.1 h1:rL3Koar5XvX0pHGfovN03f5cxLbCF2YvLeyz7D2jVDQ=
+github.com/charmbracelet/x/ansi v0.10.1/go.mod h1:3RQDQ6lDnROptfpWuUVIUG64bD2g2BgntdxH0Ya5TeE=
+github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd h1:vy0GVL4jeHEwG5YOXDmi86oYw2yuYUGqz6a8sLwg0X8=
+github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd/go.mod h1:xe0nKWGd3eJgtqZRaN9RjMtK7xUYchjzPr7q6kcvCCs=
+github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQaGIAQ=
+github.com/charmbracelet/x/term v0.2.1/go.mod h1:oQ4enTYFV7QN4m0i9mzHrViD7TQKvNEEkHUMCmsxdUg=
+github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f h1:Y/CXytFA4m6baUTXGLOoWe4PQhGxaX0KpnayAqC48p4=
+github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f/go.mod h1:vw97MGsxSvLiUE2X8qFplwetxpGLQrlU1Q9AUEIzCaM=
+github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
+github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
+github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
+github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
+github.com/mattn/go-localereader v0.0.1 h1:ygSAOl7ZXTx4RdPYinUpg6W99U8jWvWi9Ye2JC/oIi4=
+github.com/mattn/go-localereader v0.0.1/go.mod h1:8fBrzywKY7BI3czFoHkuzRoWE9C+EiG4R1k4Cjx5p88=
+github.com/mattn/go-runewidth v0.0.16 h1:E5ScNMtiwvlvB5paMFdw9p4kSQzbXFikJ5SQO6TULQc=
+github.com/mattn/go-runewidth v0.0.16/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
+github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 h1:ZK8zHtRHOkbHy6Mmr5D264iyp3TiX5OmNcI5cIARiQI=
+github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6/go.mod h1:CJlz5H+gyd6CUWT45Oy4q24RdLyn7Md9Vj2/ldJBSIo=
+github.com/muesli/cancelreader v0.2.2 h1:3I4Kt4BQjOR54NavqnDogx/MIoWBFa0StPA8ELUXHmA=
+github.com/muesli/cancelreader v0.2.2/go.mod h1:3XuTXfFS2VjM+HTLZY9Ak0l6eUKfijIfMUZ4EgX0QYo=
+github.com/muesli/termenv v0.16.0 h1:S5AlUN9dENB57rsbnkPyfdGuWIlkmzJjbFf0Tf5FWUc=
+github.com/muesli/termenv v0.16.0/go.mod h1:ZRfOIKPFDYQoDFF4Olj7/QJbW60Ol/kL1pU3VfY/Cnk=
+github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
+github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
+github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
+github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
+github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM=
+golang.org/x/exp v0.0.0-20220909182711-5c715a9e8561 h1:MDc5xs78ZrZr3HMQugiXOAkSZtfTpbJLDr/lwfgO53E=
+golang.org/x/exp v0.0.0-20220909182711-5c715a9e8561/go.mod h1:cyybsKvd6eL0RnXn6p/Grxp8F5bW7iYuBgsNCOHpMYE=
+golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.36.0 h1:KVRy2GtZBrk1cBYA7MKu5bEZFxQk4NIDV6RLVcC8o0k=
+golang.org/x/sys v0.36.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
+golang.org/x/text v0.3.8 h1:nAL+RVCQ9uMn3vJZbV+MRnydTJFPf8qqY42YiA6MrqY=
+golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ=

pkg/logic/ping.go → internal/ping/ping.go

@@ -4,16 +4,16 @@
 package ping
 
 import (
+	"errors"
 	"os/exec"
-	"strings"
 	"strconv"
-	"errors"
+	"strings"
 )
 
 // runPing returns the byte array as returned by [exec.Command]
 //
 // NOTE(os): this function may fail on non-unix compliant implementations of the Ping spec.
-func runPing(address string) (delay *[]byte, err error){
+func runPing(address string) (delay *[]byte, err error) {
 	out, err := exec.Command("ping", address, "-c 1").Output()
 	if err != nil {
 		return nil, err
@@ -41,16 +41,16 @@ func Ping(address string) (delay float64, err error) {
 
 	lines := splitBytesToLines(out)
 
-	for i:=0;i<len(lines);i++ {
+	for i := 0; i < len(lines); i++ {
 		if strings.Contains(lines[i], "bytes from") {
 			position := strings.Index(lines[i], "time=")
 
 			before, _, success := strings.Cut(lines[i][position:], " ")
-			if ! success {
+			if !success {
 				return -1, errors.New("Line does not match pattern!")
 			}
 			_, after, success := strings.Cut(before, "=")
-			if ! success {
+			if !success {
 				return -1, errors.New("Line does not match pattern!")
 			}
 

internal/tui/tui.go

@@ -0,0 +1,34 @@
+package tui
+
+import (
+	tea "github.com/charmbracelet/bubbletea"
+)
+
+// Bubbletea model
+//
+// BUG(state): how do declare pointer here?
+type Model struct {
+	Addresses []Address // as defined in [internal/tui/types.go]
+}
+
+func InitialModel(addresses []string) Model {
+	var model Model
+	for _, address := range addresses {
+		var addr Address
+		addr.Address = address
+		model.Addresses = append(model.Addresses, addr)
+	}
+	return model
+}
+
+func (m *Model) Init() tea.Cmd {
+	return nil
+}
+
+func (m *Model) View() string {
+	return ""
+}
+
+func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+	return m, nil
+}

internal/tui/types.go

@@ -0,0 +1,32 @@
+package tui
+
+import "pingo/internal/ping"
+
+type Address struct {
+	Address string
+	results []float64
+}
+
+// Wraps [ping.Ping]
+func (a *Address) Ping() (delay float64, err error) {
+	return ping.Ping(a.Address)
+}
+
+// Poll pings the affiliated Address and appends it to a.results
+func (a *Address) Poll() (success bool, err error) {
+	if delay, err := a.Ping(); err == nil {
+		a.results = append(a.results, delay)
+		return true, nil
+	} else {
+		return false, err
+	}
+}
+
+// Last returns the last result in [Address.results]. Returns -1 if no previous result
+func (a *Address) Last() (delay float64) {
+	if len(a.results) > 0 {
+		return a.results[len(a.results)-1]
+	} else {
+		return -1
+	}
+}

main.go

@@ -1,24 +1,36 @@
 package main
 
 import (
-	"pingo/pkg/logic"
-	"flag"
 	"fmt"
+	"pingo/internal/tui"
 )
 
 func main() {
-	flag.Parse()
-	hosts := flag.Args()
+	var model = tui.InitialModel([]string{"google.ca"})
+	fmt.Printf("%v\n", model)
 
-	if len(hosts) == 0 {
-		fmt.Println("Must specify hosts!")
-		return
+	for _, element := range model.Addresses {
+		fmt.Printf("\t%v\n", element)
+		element.Poll()
+		fmt.Printf("\t%v\n", element)
 	}
+	fmt.Printf("%v\n", model)
+}
 
-	for i:=0;i<len(hosts);i++ {
-		ping, _ := ping.Ping(hosts[i])
-		fmt.Printf("%s:\t%f\n", hosts[i], ping)
-	}
+// p := tea.NewProgram(tui.InitialModel())
+// if _, err := p.Run(); err != nil {
+// 	fmt.Printf("Alas, there's been an error: %v", err)
+// 	os.Exit(1)
+// }
+// flag.Parse()
+// hosts := flag.Args()
 
-	return
-}
+// if len(hosts) == 0 {
+// 	fmt.Println("Must specify hosts!")
+// 	return
+// }
+
+// for i := 0; i < len(hosts); i++ {
+// 	ping, _ := ping.Ping(hosts[i])
+// 	fmt.Printf("%s:\t%f\n", hosts[i], ping)
+// }

resources

@@ -0,0 +1,16 @@
+|--------------------+--------------------------------------------+----------------------------------------|
+| name               | url                                        | use                                    |
+|--------------------+--------------------------------------------+----------------------------------------|
+| Core frameworks    |                                            |                                        |
+| bubbletea          | https://github.com/charmbracelet/bubbletea | TUI framework                          |
+| lipgloss           | https://github.com/charmbracelet/lipgloss  | Terminal text formatting framework     |
+|--------------------+--------------------------------------------+----------------------------------------|
+| TUI widget modules |                                            |                                        |
+| bubbles            | https://github.com/charmbracelet/bubbles   | widget lib for bubble tea framework    |
+| ntcharts           | https://github.com/NimbleMarkets/ntcharts  | chart widgets for bubble tea framework |
+|--------------------+--------------------------------------------+----------------------------------------|
+| extras             |                                            |                                        |
+| wish               | https://github.com/charmbracelet/wish      | ssh TUI clients                        |
+|--------------------+--------------------------------------------+----------------------------------------|
+
+-- vim: nowrap