repo.go

  1package repo
  2
  3import (
  4	"fmt"
  5
  6	"github.com/charmbracelet/bubbles/help"
  7	"github.com/charmbracelet/bubbles/key"
  8	"github.com/charmbracelet/bubbles/spinner"
  9	tea "github.com/charmbracelet/bubbletea"
 10	"github.com/charmbracelet/lipgloss"
 11	"github.com/charmbracelet/soft-serve/git"
 12	"github.com/charmbracelet/soft-serve/server/backend"
 13	"github.com/charmbracelet/soft-serve/server/ui/common"
 14	"github.com/charmbracelet/soft-serve/server/ui/components/footer"
 15	"github.com/charmbracelet/soft-serve/server/ui/components/statusbar"
 16	"github.com/charmbracelet/soft-serve/server/ui/components/tabs"
 17)
 18
 19type state int
 20
 21const (
 22	loadingState state = iota
 23	readyState
 24)
 25
 26type tab int
 27
 28const (
 29	readmeTab tab = iota
 30	filesTab
 31	commitsTab
 32	branchesTab
 33	tagsTab
 34	lastTab
 35)
 36
 37func (t tab) String() string {
 38	return []string{
 39		"Readme",
 40		"Files",
 41		"Commits",
 42		"Branches",
 43		"Tags",
 44	}[t]
 45}
 46
 47// EmptyRepoMsg is a message to indicate that the repository is empty.
 48type EmptyRepoMsg struct{}
 49
 50// CopyURLMsg is a message to copy the URL of the current repository.
 51type CopyURLMsg struct{}
 52
 53// UpdateStatusBarMsg updates the status bar.
 54type UpdateStatusBarMsg struct{}
 55
 56// RepoMsg is a message that contains a git.Repository.
 57type RepoMsg backend.Repository
 58
 59// BackMsg is a message to go back to the previous view.
 60type BackMsg struct{}
 61
 62// CopyMsg is a message to indicate copied text.
 63type CopyMsg struct {
 64	Text    string
 65	Message string
 66}
 67
 68// Repo is a view for a git repository.
 69type Repo struct {
 70	common       common.Common
 71	selectedRepo backend.Repository
 72	activeTab    tab
 73	tabs         *tabs.Tabs
 74	statusbar    *statusbar.StatusBar
 75	panes        []common.Component
 76	ref          *git.Reference
 77	state        state
 78	spinner      spinner.Model
 79	panesReady   [lastTab]bool
 80}
 81
 82// New returns a new Repo.
 83func New(c common.Common) *Repo {
 84	sb := statusbar.New(c)
 85	ts := make([]string, lastTab)
 86	// Tabs must match the order of tab constants above.
 87	for i, t := range []tab{readmeTab, filesTab, commitsTab, branchesTab, tagsTab} {
 88		ts[i] = t.String()
 89	}
 90	c.Logger = c.Logger.WithPrefix("ui.repo")
 91	tb := tabs.New(c, ts)
 92	readme := NewReadme(c)
 93	log := NewLog(c)
 94	files := NewFiles(c)
 95	branches := NewRefs(c, git.RefsHeads)
 96	tags := NewRefs(c, git.RefsTags)
 97	// Make sure the order matches the order of tab constants above.
 98	panes := []common.Component{
 99		readme,
100		files,
101		log,
102		branches,
103		tags,
104	}
105	s := spinner.New(spinner.WithSpinner(spinner.Dot),
106		spinner.WithStyle(c.Styles.Spinner))
107	r := &Repo{
108		common:    c,
109		tabs:      tb,
110		statusbar: sb,
111		panes:     panes,
112		state:     loadingState,
113		spinner:   s,
114	}
115	return r
116}
117
118// SetSize implements common.Component.
119func (r *Repo) SetSize(width, height int) {
120	r.common.SetSize(width, height)
121	hm := r.common.Styles.Repo.Body.GetVerticalFrameSize() +
122		r.common.Styles.Repo.Header.GetHeight() +
123		r.common.Styles.Repo.Header.GetVerticalFrameSize() +
124		r.common.Styles.StatusBar.GetHeight()
125	r.tabs.SetSize(width, height-hm)
126	r.statusbar.SetSize(width, height-hm)
127	for _, p := range r.panes {
128		p.SetSize(width, height-hm)
129	}
130}
131
132func (r *Repo) commonHelp() []key.Binding {
133	b := make([]key.Binding, 0)
134	back := r.common.KeyMap.Back
135	back.SetHelp("esc", "back to menu")
136	tab := r.common.KeyMap.Section
137	tab.SetHelp("tab", "switch tab")
138	b = append(b, back)
139	b = append(b, tab)
140	return b
141}
142
143// ShortHelp implements help.KeyMap.
144func (r *Repo) ShortHelp() []key.Binding {
145	b := r.commonHelp()
146	b = append(b, r.panes[r.activeTab].(help.KeyMap).ShortHelp()...)
147	return b
148}
149
150// FullHelp implements help.KeyMap.
151func (r *Repo) FullHelp() [][]key.Binding {
152	b := make([][]key.Binding, 0)
153	b = append(b, r.commonHelp())
154	b = append(b, r.panes[r.activeTab].(help.KeyMap).FullHelp()...)
155	return b
156}
157
158// Init implements tea.View.
159func (r *Repo) Init() tea.Cmd {
160	return tea.Batch(
161		r.tabs.Init(),
162		r.statusbar.Init(),
163	)
164}
165
166// Update implements tea.Model.
167func (r *Repo) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
168	cfg := r.common.Config()
169	cmds := make([]tea.Cmd, 0)
170	switch msg := msg.(type) {
171	case RepoMsg:
172		// Set the state to loading when we get a new repository.
173		r.state = loadingState
174		r.panesReady = [lastTab]bool{}
175		r.activeTab = 0
176		r.selectedRepo = msg
177		cmds = append(cmds,
178			r.tabs.Init(),
179			// This will set the selected repo in each pane's model.
180			r.updateModels(msg),
181			r.spinner.Tick,
182		)
183	case RefMsg:
184		r.ref = msg
185		for _, p := range r.panes {
186			// Init will initiate each pane's model with its contents.
187			cmds = append(cmds, p.Init())
188		}
189		cmds = append(cmds,
190			r.updateStatusBarCmd,
191			r.updateModels(msg),
192		)
193	case tabs.SelectTabMsg:
194		r.activeTab = tab(msg)
195		t, cmd := r.tabs.Update(msg)
196		r.tabs = t.(*tabs.Tabs)
197		if cmd != nil {
198			cmds = append(cmds, cmd)
199		}
200	case tabs.ActiveTabMsg:
201		r.activeTab = tab(msg)
202		if r.selectedRepo != nil {
203			cmds = append(cmds,
204				r.updateStatusBarCmd,
205			)
206		}
207	case tea.KeyMsg, tea.MouseMsg:
208		t, cmd := r.tabs.Update(msg)
209		r.tabs = t.(*tabs.Tabs)
210		if cmd != nil {
211			cmds = append(cmds, cmd)
212		}
213		if r.selectedRepo != nil {
214			cmds = append(cmds, r.updateStatusBarCmd)
215			urlID := fmt.Sprintf("%s-url", r.selectedRepo.Name())
216			cmd := common.CloneCmd(cfg.SSH.PublicURL, r.selectedRepo.Name())
217			if msg, ok := msg.(tea.MouseMsg); ok && r.common.Zone.Get(urlID).InBounds(msg) {
218				cmds = append(cmds, copyCmd(cmd, "Command copied to clipboard"))
219			}
220		}
221		switch msg := msg.(type) {
222		case tea.MouseMsg:
223			switch msg.Type {
224			case tea.MouseLeft:
225				switch {
226				case r.common.Zone.Get("repo-help").InBounds(msg):
227					cmds = append(cmds, footer.ToggleFooterCmd)
228				}
229			case tea.MouseRight:
230				switch {
231				case r.common.Zone.Get("repo-main").InBounds(msg):
232					cmds = append(cmds, backCmd)
233				}
234			}
235		}
236	case CopyMsg:
237		txt := msg.Text
238		r.common.Output().Copy(txt)
239		cmds = append(cmds, func() tea.Msg {
240			return statusbar.StatusBarMsg{
241				Value: msg.Message,
242			}
243		})
244	case ReadmeMsg, FileItemsMsg, LogCountMsg, LogItemsMsg, RefItemsMsg:
245		cmds = append(cmds, r.updateRepo(msg))
246	// We have two spinners, one is used to when loading the repository and the
247	// other is used when loading the log.
248	// Check if the spinner ID matches the spinner model.
249	case spinner.TickMsg:
250		switch msg.ID {
251		case r.spinner.ID():
252			if r.state == loadingState {
253				s, cmd := r.spinner.Update(msg)
254				r.spinner = s
255				if cmd != nil {
256					cmds = append(cmds, cmd)
257				}
258			}
259		default:
260			cmds = append(cmds, r.updateRepo(msg))
261		}
262	case UpdateStatusBarMsg:
263		cmds = append(cmds, r.updateStatusBarCmd)
264	case tea.WindowSizeMsg:
265		cmds = append(cmds, r.updateModels(msg))
266	case EmptyRepoMsg:
267		r.ref = nil
268		r.state = readyState
269		cmds = append(cmds,
270			r.updateModels(msg),
271			r.updateStatusBarCmd,
272		)
273	case common.ErrorMsg:
274		r.state = readyState
275	}
276	s, cmd := r.statusbar.Update(msg)
277	r.statusbar = s.(*statusbar.StatusBar)
278	if cmd != nil {
279		cmds = append(cmds, cmd)
280	}
281	m, cmd := r.panes[r.activeTab].Update(msg)
282	r.panes[r.activeTab] = m.(common.Component)
283	if cmd != nil {
284		cmds = append(cmds, cmd)
285	}
286	return r, tea.Batch(cmds...)
287}
288
289// View implements tea.Model.
290func (r *Repo) View() string {
291	s := r.common.Styles.Repo.Base.Copy().
292		Width(r.common.Width).
293		Height(r.common.Height)
294	repoBodyStyle := r.common.Styles.Repo.Body.Copy()
295	hm := repoBodyStyle.GetVerticalFrameSize() +
296		r.common.Styles.Repo.Header.GetHeight() +
297		r.common.Styles.Repo.Header.GetVerticalFrameSize() +
298		r.common.Styles.StatusBar.GetHeight() +
299		r.common.Styles.Tabs.GetHeight() +
300		r.common.Styles.Tabs.GetVerticalFrameSize()
301	mainStyle := repoBodyStyle.
302		Height(r.common.Height - hm)
303	var main string
304	var statusbar string
305	switch r.state {
306	case loadingState:
307		main = fmt.Sprintf("%s loading…", r.spinner.View())
308	case readyState:
309		main = r.panes[r.activeTab].View()
310		statusbar = r.statusbar.View()
311	}
312	main = r.common.Zone.Mark(
313		"repo-main",
314		mainStyle.Render(main),
315	)
316	view := lipgloss.JoinVertical(lipgloss.Top,
317		r.headerView(),
318		r.tabs.View(),
319		main,
320		statusbar,
321	)
322	return s.Render(view)
323}
324
325func (r *Repo) headerView() string {
326	cfg := r.common.Config()
327	if r.selectedRepo == nil {
328		return ""
329	}
330	truncate := r.common.Renderer.NewStyle().MaxWidth(r.common.Width)
331	name := r.selectedRepo.ProjectName()
332	if name == "" {
333		name = r.selectedRepo.Name()
334	}
335	name = r.common.Styles.Repo.HeaderName.Render(name)
336	desc := r.selectedRepo.Description()
337	if desc == "" {
338		desc = name
339		name = ""
340	} else {
341		desc = r.common.Styles.Repo.HeaderDesc.Render(desc)
342	}
343	urlStyle := r.common.Styles.URLStyle.Copy().
344		Width(r.common.Width - lipgloss.Width(desc) - 1).
345		Align(lipgloss.Right)
346	var url string
347	url = common.CloneCmd(cfg.SSH.PublicURL, r.selectedRepo.Name())
348	url = common.TruncateString(url, r.common.Width-lipgloss.Width(desc)-1)
349	url = r.common.Zone.Mark(
350		fmt.Sprintf("%s-url", r.selectedRepo.Name()),
351		urlStyle.Render(url),
352	)
353	style := r.common.Styles.Repo.Header.Copy().Width(r.common.Width)
354	return style.Render(
355		lipgloss.JoinVertical(lipgloss.Top,
356			truncate.Render(name),
357			truncate.Render(lipgloss.JoinHorizontal(lipgloss.Left,
358				desc,
359				url,
360			)),
361		),
362	)
363}
364
365func (r *Repo) updateStatusBarCmd() tea.Msg {
366	if r.selectedRepo == nil {
367		return nil
368	}
369	value := r.panes[r.activeTab].(statusbar.Model).StatusBarValue()
370	info := r.panes[r.activeTab].(statusbar.Model).StatusBarInfo()
371	branch := "*"
372	if r.ref != nil {
373		branch += " " + r.ref.Name().Short()
374	}
375	return statusbar.StatusBarMsg{
376		Key:   r.selectedRepo.Name(),
377		Value: value,
378		Info:  info,
379		Extra: branch,
380	}
381}
382
383func (r *Repo) updateModels(msg tea.Msg) tea.Cmd {
384	cmds := make([]tea.Cmd, 0)
385	for i, b := range r.panes {
386		m, cmd := b.Update(msg)
387		r.panes[i] = m.(common.Component)
388		if cmd != nil {
389			cmds = append(cmds, cmd)
390		}
391	}
392	return tea.Batch(cmds...)
393}
394
395func (r *Repo) updateRepo(msg tea.Msg) tea.Cmd {
396	cmds := make([]tea.Cmd, 0)
397	switch msg := msg.(type) {
398	case LogCountMsg, LogItemsMsg, spinner.TickMsg:
399		switch msg.(type) {
400		case LogItemsMsg:
401			r.panesReady[commitsTab] = true
402		}
403		l, cmd := r.panes[commitsTab].Update(msg)
404		r.panes[commitsTab] = l.(*Log)
405		if cmd != nil {
406			cmds = append(cmds, cmd)
407		}
408	case FileItemsMsg:
409		r.panesReady[filesTab] = true
410		f, cmd := r.panes[filesTab].Update(msg)
411		r.panes[filesTab] = f.(*Files)
412		if cmd != nil {
413			cmds = append(cmds, cmd)
414		}
415	case RefItemsMsg:
416		switch msg.prefix {
417		case git.RefsHeads:
418			r.panesReady[branchesTab] = true
419			b, cmd := r.panes[branchesTab].Update(msg)
420			r.panes[branchesTab] = b.(*Refs)
421			if cmd != nil {
422				cmds = append(cmds, cmd)
423			}
424		case git.RefsTags:
425			r.panesReady[tagsTab] = true
426			t, cmd := r.panes[tagsTab].Update(msg)
427			r.panes[tagsTab] = t.(*Refs)
428			if cmd != nil {
429				cmds = append(cmds, cmd)
430			}
431		}
432	case ReadmeMsg:
433		r.panesReady[readmeTab] = true
434	}
435	if r.isReady() {
436		r.state = readyState
437	}
438	return tea.Batch(cmds...)
439}
440
441func (r *Repo) isReady() bool {
442	ready := true
443	// We purposely ignore the log pane here because it has its own spinner.
444	for _, b := range []bool{
445		r.panesReady[filesTab], r.panesReady[branchesTab],
446		r.panesReady[tagsTab], r.panesReady[readmeTab],
447	} {
448		if !b {
449			ready = false
450			break
451		}
452	}
453	return ready
454}
455
456func copyCmd(text, msg string) tea.Cmd {
457	return func() tea.Msg {
458		return CopyMsg{
459			Text:    text,
460			Message: msg,
461		}
462	}
463}
464
465func updateStatusBarCmd() tea.Msg {
466	return UpdateStatusBarMsg{}
467}
468
469func backCmd() tea.Msg {
470	return BackMsg{}
471}