ui.go

  1package ui
  2
  3import (
  4	"log"
  5	"os"
  6
  7	"github.com/charmbracelet/bubbles/key"
  8	tea "github.com/charmbracelet/bubbletea"
  9	"github.com/charmbracelet/lipgloss"
 10	"github.com/charmbracelet/soft-serve/config"
 11	"github.com/charmbracelet/soft-serve/ui/common"
 12	"github.com/charmbracelet/soft-serve/ui/components/footer"
 13	"github.com/charmbracelet/soft-serve/ui/components/header"
 14	"github.com/charmbracelet/soft-serve/ui/components/selector"
 15	"github.com/charmbracelet/soft-serve/ui/git"
 16	"github.com/charmbracelet/soft-serve/ui/pages/repo"
 17	"github.com/charmbracelet/soft-serve/ui/pages/selection"
 18	"github.com/gliderlabs/ssh"
 19)
 20
 21type page int
 22
 23const (
 24	selectionPage page = iota
 25	repoPage
 26)
 27
 28type sessionState int
 29
 30const (
 31	startState sessionState = iota
 32	errorState
 33	loadedState
 34)
 35
 36// UI is the main UI model.
 37type UI struct {
 38	cfg         *config.Config
 39	session     ssh.Session
 40	rs          git.GitRepoSource
 41	initialRepo string
 42	common      common.Common
 43	pages       []common.Component
 44	activePage  page
 45	state       sessionState
 46	header      *header.Header
 47	footer      *footer.Footer
 48	showFooter  bool
 49	error       error
 50}
 51
 52// New returns a new UI model.
 53func New(cfg *config.Config, s ssh.Session, c common.Common, initialRepo string) *UI {
 54	src := &source{cfg.Source}
 55	h := header.New(c, cfg.Name)
 56	ui := &UI{
 57		cfg:         cfg,
 58		session:     s,
 59		rs:          src,
 60		common:      c,
 61		pages:       make([]common.Component, 2), // selection & repo
 62		activePage:  selectionPage,
 63		state:       startState,
 64		header:      h,
 65		initialRepo: initialRepo,
 66		showFooter:  true,
 67	}
 68	ui.footer = footer.New(c, ui)
 69	return ui
 70}
 71
 72func (ui *UI) getMargins() (wm, hm int) {
 73	style := ui.common.Styles.App.Copy()
 74	switch ui.activePage {
 75	case selectionPage:
 76		hm += ui.common.Styles.Header.GetHeight() +
 77			ui.common.Styles.Header.GetVerticalFrameSize()
 78	case repoPage:
 79	}
 80	wm += style.GetHorizontalFrameSize()
 81	hm += style.GetVerticalFrameSize()
 82	if ui.showFooter {
 83		// NOTE: we don't use the footer's style to determine the margins
 84		// because footer.Height() is the height of the footer after applying
 85		// the styles.
 86		hm += ui.footer.Height()
 87	}
 88	return
 89}
 90
 91// ShortHelp implements help.KeyMap.
 92func (ui *UI) ShortHelp() []key.Binding {
 93	b := make([]key.Binding, 0)
 94	switch ui.state {
 95	case errorState:
 96		b = append(b, ui.common.KeyMap.Back)
 97	case loadedState:
 98		b = append(b, ui.pages[ui.activePage].ShortHelp()...)
 99	}
100	b = append(b,
101		ui.common.KeyMap.Quit,
102		ui.common.KeyMap.Help,
103	)
104	return b
105}
106
107// FullHelp implements help.KeyMap.
108func (ui *UI) FullHelp() [][]key.Binding {
109	b := make([][]key.Binding, 0)
110	switch ui.state {
111	case errorState:
112		b = append(b, []key.Binding{ui.common.KeyMap.Back})
113	case loadedState:
114		b = append(b, ui.pages[ui.activePage].FullHelp()...)
115	}
116	b = append(b, []key.Binding{
117		ui.common.KeyMap.Quit,
118		ui.common.KeyMap.Help,
119	})
120	return b
121}
122
123// SetSize implements common.Component.
124func (ui *UI) SetSize(width, height int) {
125	ui.common.SetSize(width, height)
126	wm, hm := ui.getMargins()
127	ui.header.SetSize(width-wm, height-hm)
128	ui.footer.SetSize(width-wm, height-hm)
129	for _, p := range ui.pages {
130		if p != nil {
131			p.SetSize(width-wm, height-hm)
132		}
133	}
134}
135
136// Init implements tea.Model.
137func (ui *UI) Init() tea.Cmd {
138	ui.pages[selectionPage] = selection.New(
139		ui.cfg,
140		ui.session.PublicKey(),
141		ui.common,
142	)
143	ui.pages[repoPage] = repo.New(
144		ui.cfg,
145		ui.rs,
146		ui.common,
147	)
148	ui.SetSize(ui.common.Width, ui.common.Height)
149	cmds := make([]tea.Cmd, 0)
150	cmds = append(cmds,
151		ui.pages[selectionPage].Init(),
152		ui.pages[repoPage].Init(),
153	)
154	if ui.initialRepo != "" {
155		cmds = append(cmds, ui.initialRepoCmd(ui.initialRepo))
156	}
157	ui.state = loadedState
158	ui.SetSize(ui.common.Width, ui.common.Height)
159	return tea.Batch(cmds...)
160}
161
162// Update implements tea.Model.
163func (ui *UI) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
164	if os.Getenv("DEBUG") == "true" {
165		log.Printf("ui msg: %T", msg)
166	}
167	cmds := make([]tea.Cmd, 0)
168	switch msg := msg.(type) {
169	case tea.WindowSizeMsg:
170		ui.SetSize(msg.Width, msg.Height)
171		for i, p := range ui.pages {
172			m, cmd := p.Update(msg)
173			ui.pages[i] = m.(common.Component)
174			if cmd != nil {
175				cmds = append(cmds, cmd)
176			}
177		}
178	case tea.KeyMsg, tea.MouseMsg:
179		switch msg := msg.(type) {
180		case tea.KeyMsg:
181			switch {
182			case key.Matches(msg, ui.common.KeyMap.Back) && ui.error != nil:
183				ui.error = nil
184				ui.state = loadedState
185				// Always show the footer on error.
186				ui.showFooter = true
187			case key.Matches(msg, ui.common.KeyMap.Help):
188				ui.footer.SetShowAll(!ui.footer.ShowAll())
189				// Show the footer when on repo page and shot all help.
190				if ui.activePage == repoPage {
191					ui.showFooter = !ui.showFooter
192				}
193			case key.Matches(msg, ui.common.KeyMap.Quit):
194				return ui, tea.Quit
195			case ui.activePage == repoPage && key.Matches(msg, ui.common.KeyMap.Back):
196				ui.activePage = selectionPage
197				// Always show the footer on selection page.
198				ui.showFooter = true
199			}
200		}
201	case repo.RepoMsg:
202		ui.activePage = repoPage
203		// Show the footer on repo page if show all is set.
204		ui.showFooter = ui.footer.ShowAll()
205	case common.ErrorMsg:
206		ui.error = msg
207		ui.state = errorState
208		return ui, nil
209	case selector.SelectMsg:
210		switch msg.IdentifiableItem.(type) {
211		case selection.Item:
212			if ui.activePage == selectionPage {
213				cmds = append(cmds, ui.setRepoCmd(msg.ID()))
214			}
215		}
216	}
217	h, cmd := ui.header.Update(msg)
218	ui.header = h.(*header.Header)
219	if cmd != nil {
220		cmds = append(cmds, cmd)
221	}
222	f, cmd := ui.footer.Update(msg)
223	ui.footer = f.(*footer.Footer)
224	if cmd != nil {
225		cmds = append(cmds, cmd)
226	}
227	if ui.state == loadedState {
228		m, cmd := ui.pages[ui.activePage].Update(msg)
229		ui.pages[ui.activePage] = m.(common.Component)
230		if cmd != nil {
231			cmds = append(cmds, cmd)
232		}
233	}
234	// This fixes determining the height margin of the footer.
235	ui.SetSize(ui.common.Width, ui.common.Height)
236	return ui, tea.Batch(cmds...)
237}
238
239// View implements tea.Model.
240func (ui *UI) View() string {
241	var view string
242	wm, hm := ui.getMargins()
243	style := ui.common.Styles.App.Copy()
244	switch ui.state {
245	case startState:
246		view = "Loading..."
247	case errorState:
248		err := ui.common.Styles.ErrorTitle.Render("Bummer")
249		err += ui.common.Styles.ErrorBody.Render(ui.error.Error())
250		view = ui.common.Styles.Error.Copy().
251			Width(ui.common.Width -
252				wm -
253				ui.common.Styles.ErrorBody.GetHorizontalFrameSize()).
254			Height(ui.common.Height -
255				hm -
256				ui.common.Styles.Error.GetVerticalFrameSize()).
257			Render(err)
258	case loadedState:
259		view = ui.pages[ui.activePage].View()
260	default:
261		view = "Unknown state :/ this is a bug!"
262	}
263	switch ui.activePage {
264	case selectionPage:
265		view = lipgloss.JoinVertical(lipgloss.Bottom,
266			ui.header.View(),
267			view,
268		)
269	case repoPage:
270	}
271	if ui.showFooter {
272		view = lipgloss.JoinVertical(lipgloss.Bottom,
273			view,
274			ui.footer.View(),
275		)
276	}
277	return style.Render(
278		view,
279	)
280}
281
282func (ui *UI) setRepoCmd(rn string) tea.Cmd {
283	return func() tea.Msg {
284		for _, r := range ui.rs.AllRepos() {
285			if r.Repo() == rn {
286				return repo.RepoMsg(r)
287			}
288		}
289		return common.ErrorMsg(git.ErrMissingRepo)
290	}
291}
292
293func (ui *UI) initialRepoCmd(rn string) tea.Cmd {
294	return func() tea.Msg {
295		for _, r := range ui.rs.AllRepos() {
296			if r.Repo() == rn {
297				return repo.RepoMsg(r)
298			}
299		}
300		return nil
301	}
302}