1package repo
2
3import (
4 "fmt"
5 "strings"
6 "time"
7
8 "github.com/charmbracelet/bubbles/key"
9 "github.com/charmbracelet/bubbles/spinner"
10 tea "github.com/charmbracelet/bubbletea"
11 gansi "github.com/charmbracelet/glamour/ansi"
12 "github.com/charmbracelet/lipgloss"
13 ggit "github.com/charmbracelet/soft-serve/git"
14 "github.com/charmbracelet/soft-serve/ui/common"
15 "github.com/charmbracelet/soft-serve/ui/components/selector"
16 "github.com/charmbracelet/soft-serve/ui/components/viewport"
17 "github.com/charmbracelet/soft-serve/ui/git"
18 "github.com/muesli/reflow/wrap"
19 "github.com/muesli/termenv"
20)
21
22var (
23 waitBeforeLoading = time.Millisecond * 100
24)
25
26type logView int
27
28const (
29 logViewCommits logView = iota
30 logViewDiff
31)
32
33// LogCountMsg is a message that contains the number of commits in a repo.
34type LogCountMsg int64
35
36// LogItemsMsg is a message that contains a slice of LogItem.
37type LogItemsMsg []selector.IdentifiableItem
38
39// LogCommitMsg is a message that contains a git commit.
40type LogCommitMsg *ggit.Commit
41
42// LogDiffMsg is a message that contains a git diff.
43type LogDiffMsg *ggit.Diff
44
45// Log is a model that displays a list of commits and their diffs.
46type Log struct {
47 common common.Common
48 selector *selector.Selector
49 vp *viewport.Viewport
50 activeView logView
51 repo git.GitRepo
52 ref *ggit.Reference
53 count int64
54 nextPage int
55 activeCommit *ggit.Commit
56 selectedCommit *ggit.Commit
57 currentDiff *ggit.Diff
58 loadingTime time.Time
59 loading bool
60 spinner spinner.Model
61}
62
63// NewLog creates a new Log model.
64func NewLog(common common.Common) *Log {
65 l := &Log{
66 common: common,
67 vp: viewport.New(common),
68 activeView: logViewCommits,
69 }
70 selector := selector.New(common, []selector.IdentifiableItem{}, LogItemDelegate{&common})
71 selector.SetShowFilter(false)
72 selector.SetShowHelp(false)
73 selector.SetShowPagination(false)
74 selector.SetShowStatusBar(false)
75 selector.SetShowTitle(false)
76 selector.SetFilteringEnabled(false)
77 selector.DisableQuitKeybindings()
78 selector.KeyMap.NextPage = common.KeyMap.NextPage
79 selector.KeyMap.PrevPage = common.KeyMap.PrevPage
80 l.selector = selector
81 s := spinner.New()
82 s.Spinner = spinner.Dot
83 s.Style = common.Styles.Spinner
84 l.spinner = s
85 return l
86}
87
88// SetSize implements common.Component.
89func (l *Log) SetSize(width, height int) {
90 l.common.SetSize(width, height)
91 l.selector.SetSize(width, height)
92 l.vp.SetSize(width, height)
93}
94
95// ShortHelp implements help.KeyMap.
96func (l *Log) ShortHelp() []key.Binding {
97 switch l.activeView {
98 case logViewCommits:
99 copyKey := l.common.KeyMap.Copy
100 copyKey.SetHelp("c", "copy hash")
101 return []key.Binding{
102 l.common.KeyMap.UpDown,
103 l.common.KeyMap.SelectItem,
104 copyKey,
105 }
106 case logViewDiff:
107 return []key.Binding{
108 l.common.KeyMap.UpDown,
109 l.common.KeyMap.BackItem,
110 }
111 default:
112 return []key.Binding{}
113 }
114}
115
116// FullHelp implements help.KeyMap.
117func (l *Log) FullHelp() [][]key.Binding {
118 k := l.selector.KeyMap
119 b := make([][]key.Binding, 0)
120 switch l.activeView {
121 case logViewCommits:
122 copyKey := l.common.KeyMap.Copy
123 copyKey.SetHelp("c", "copy hash")
124 b = append(b, []key.Binding{
125 l.common.KeyMap.SelectItem,
126 l.common.KeyMap.BackItem,
127 })
128 b = append(b, [][]key.Binding{
129 {
130 copyKey,
131 k.CursorUp,
132 k.CursorDown,
133 },
134 {
135 k.NextPage,
136 k.PrevPage,
137 k.GoToStart,
138 k.GoToEnd,
139 },
140 }...)
141 case logViewDiff:
142 k := l.vp.KeyMap
143 b = append(b, []key.Binding{
144 l.common.KeyMap.BackItem,
145 })
146 b = append(b, [][]key.Binding{
147 {
148 k.PageDown,
149 k.PageUp,
150 k.HalfPageDown,
151 k.HalfPageUp,
152 },
153 {
154 k.Down,
155 k.Up,
156 },
157 }...)
158 }
159 return b
160}
161
162func (l *Log) startLoading() tea.Cmd {
163 l.loadingTime = time.Now()
164 l.loading = true
165 return l.spinner.Tick
166}
167
168func (l *Log) stopLoading() tea.Cmd {
169 l.loading = false
170 return updateStatusBarCmd
171}
172
173// Init implements tea.Model.
174func (l *Log) Init() tea.Cmd {
175 l.activeView = logViewCommits
176 l.nextPage = 0
177 l.count = 0
178 l.activeCommit = nil
179 l.selector.Select(0)
180 return tea.Batch(
181 l.updateCommitsCmd,
182 // start loading on init
183 l.startLoading(),
184 )
185}
186
187// Update implements tea.Model.
188func (l *Log) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
189 cmds := make([]tea.Cmd, 0)
190 switch msg := msg.(type) {
191 case RepoMsg:
192 l.repo = git.GitRepo(msg)
193 cmds = append(cmds, l.Init())
194 case RefMsg:
195 l.ref = msg
196 cmds = append(cmds, l.Init())
197 case LogCountMsg:
198 l.count = int64(msg)
199 case LogItemsMsg:
200 cmds = append(cmds,
201 l.selector.SetItems(msg),
202 // stop loading after receiving items
203 l.stopLoading(),
204 )
205 l.selector.SetPage(l.nextPage)
206 l.SetSize(l.common.Width, l.common.Height)
207 i := l.selector.SelectedItem()
208 if i != nil {
209 l.activeCommit = i.(LogItem).Commit
210 }
211 case tea.KeyMsg, tea.MouseMsg:
212 switch l.activeView {
213 case logViewCommits:
214 switch key := msg.(type) {
215 case tea.KeyMsg:
216 switch key.String() {
217 case "l", "right":
218 cmds = append(cmds, l.selector.SelectItem)
219 }
220 }
221 // This is a hack for loading commits on demand based on list.Pagination.
222 curPage := l.selector.Page()
223 s, cmd := l.selector.Update(msg)
224 m := s.(*selector.Selector)
225 l.selector = m
226 if m.Page() != curPage {
227 l.nextPage = m.Page()
228 l.selector.SetPage(curPage)
229 cmds = append(cmds,
230 l.updateCommitsCmd,
231 l.startLoading(),
232 )
233 }
234 cmds = append(cmds, cmd)
235 case logViewDiff:
236 switch key := msg.(type) {
237 case tea.KeyMsg:
238 switch key.String() {
239 case "h", "left":
240 l.activeView = logViewCommits
241 }
242 }
243 }
244 case selector.ActiveMsg:
245 switch sel := msg.IdentifiableItem.(type) {
246 case LogItem:
247 l.activeCommit = sel.Commit
248 }
249 cmds = append(cmds, updateStatusBarCmd)
250 case selector.SelectMsg:
251 switch sel := msg.IdentifiableItem.(type) {
252 case LogItem:
253 cmds = append(cmds,
254 l.selectCommitCmd(sel.Commit),
255 l.startLoading(),
256 )
257 }
258 case LogCommitMsg:
259 l.selectedCommit = msg
260 cmds = append(cmds, l.loadDiffCmd)
261 case LogDiffMsg:
262 l.currentDiff = msg
263 l.vp.SetContent(
264 lipgloss.JoinVertical(lipgloss.Top,
265 l.renderCommit(l.selectedCommit),
266 l.renderSummary(msg),
267 l.renderDiff(msg),
268 ),
269 )
270 l.vp.GotoTop()
271 l.activeView = logViewDiff
272 cmds = append(cmds,
273 updateStatusBarCmd,
274 // stop loading after setting the viewport content
275 l.stopLoading(),
276 )
277 case tea.WindowSizeMsg:
278 if l.selectedCommit != nil && l.currentDiff != nil {
279 l.vp.SetContent(
280 lipgloss.JoinVertical(lipgloss.Top,
281 l.renderCommit(l.selectedCommit),
282 l.renderSummary(l.currentDiff),
283 l.renderDiff(l.currentDiff),
284 ),
285 )
286 }
287 if l.repo != nil {
288 cmds = append(cmds,
289 l.updateCommitsCmd,
290 // start loading on resize since the number of commits per page
291 // might change and we'd need to load more commits.
292 l.startLoading(),
293 )
294 }
295 }
296 if l.loading {
297 s, cmd := l.spinner.Update(msg)
298 if cmd != nil {
299 cmds = append(cmds, cmd)
300 }
301 l.spinner = s
302 }
303 switch l.activeView {
304 case logViewDiff:
305 vp, cmd := l.vp.Update(msg)
306 l.vp = vp.(*viewport.Viewport)
307 if cmd != nil {
308 cmds = append(cmds, cmd)
309 }
310 }
311 return l, tea.Batch(cmds...)
312}
313
314// View implements tea.Model.
315func (l *Log) View() string {
316 if l.loading && l.loadingTime.Add(waitBeforeLoading).Before(time.Now()) {
317 msg := fmt.Sprintf("%s loading commit", l.spinner.View())
318 if l.selectedCommit == nil {
319 msg += "s"
320 }
321 msg += "…"
322 return msg
323 }
324 switch l.activeView {
325 case logViewCommits:
326 return l.selector.View()
327 case logViewDiff:
328 return l.vp.View()
329 default:
330 return ""
331 }
332}
333
334// StatusBarValue returns the status bar value.
335func (l *Log) StatusBarValue() string {
336 if l.loading {
337 return ""
338 }
339 c := l.activeCommit
340 if c == nil {
341 return ""
342 }
343 who := c.Author.Name
344 if email := c.Author.Email; email != "" {
345 who += " <" + email + ">"
346 }
347 value := c.ID.String()
348 if who != "" {
349 value += " by " + who
350 }
351 return value
352}
353
354// StatusBarInfo returns the status bar info.
355func (l *Log) StatusBarInfo() string {
356 switch l.activeView {
357 case logViewCommits:
358 // We're using l.nextPage instead of l.selector.Paginator.Page because
359 // of the paginator hack above.
360 return fmt.Sprintf("p. %d/%d", l.nextPage+1, l.selector.TotalPages())
361 case logViewDiff:
362 return fmt.Sprintf("☰ %.f%%", l.vp.ScrollPercent()*100)
363 default:
364 return ""
365 }
366}
367
368func (l *Log) countCommitsCmd() tea.Msg {
369 if l.ref == nil {
370 return common.ErrorMsg(errNoRef)
371 }
372 count, err := l.repo.CountCommits(l.ref)
373 if err != nil {
374 return common.ErrorMsg(err)
375 }
376 return LogCountMsg(count)
377}
378
379func (l *Log) updateCommitsCmd() tea.Msg {
380 count := l.count
381 if l.count == 0 {
382 switch msg := l.countCommitsCmd().(type) {
383 case common.ErrorMsg:
384 return msg
385 case LogCountMsg:
386 count = int64(msg)
387 }
388 }
389 if l.ref == nil {
390 return common.ErrorMsg(errNoRef)
391 }
392 items := make([]selector.IdentifiableItem, count)
393 page := l.nextPage
394 limit := l.selector.PerPage()
395 skip := page * limit
396 // CommitsByPage pages start at 1
397 cc, err := l.repo.CommitsByPage(l.ref, page+1, limit)
398 if err != nil {
399 return common.ErrorMsg(err)
400 }
401 for i, c := range cc {
402 idx := i + skip
403 if int64(idx) >= count {
404 break
405 }
406 items[idx] = LogItem{Commit: c}
407 }
408 return LogItemsMsg(items)
409}
410
411func (l *Log) selectCommitCmd(commit *ggit.Commit) tea.Cmd {
412 return func() tea.Msg {
413 return LogCommitMsg(commit)
414 }
415}
416
417func (l *Log) loadDiffCmd() tea.Msg {
418 diff, err := l.repo.Diff(l.selectedCommit)
419 if err != nil {
420 return common.ErrorMsg(err)
421 }
422 return LogDiffMsg(diff)
423}
424
425func renderCtx() gansi.RenderContext {
426 return gansi.NewRenderContext(gansi.Options{
427 ColorProfile: termenv.TrueColor,
428 Styles: common.StyleConfig(),
429 })
430}
431
432func (l *Log) renderCommit(c *ggit.Commit) string {
433 s := strings.Builder{}
434 // FIXME: lipgloss prints empty lines when CRLF is used
435 // sanitize commit message from CRLF
436 msg := strings.ReplaceAll(c.Message, "\r\n", "\n")
437 s.WriteString(fmt.Sprintf("%s\n%s\n%s\n%s\n",
438 l.common.Styles.LogCommitHash.Render("commit "+c.ID.String()),
439 l.common.Styles.LogCommitAuthor.Render(fmt.Sprintf("Author: %s <%s>", c.Author.Name, c.Author.Email)),
440 l.common.Styles.LogCommitDate.Render("Date: "+c.Committer.When.Format(time.UnixDate)),
441 l.common.Styles.LogCommitBody.Render(msg),
442 ))
443 return wrap.String(s.String(), l.common.Width-2)
444}
445
446func (l *Log) renderSummary(diff *ggit.Diff) string {
447 stats := strings.Split(diff.Stats().String(), "\n")
448 for i, line := range stats {
449 ch := strings.Split(line, "|")
450 if len(ch) > 1 {
451 adddel := ch[len(ch)-1]
452 adddel = strings.ReplaceAll(adddel, "+", l.common.Styles.LogCommitStatsAdd.Render("+"))
453 adddel = strings.ReplaceAll(adddel, "-", l.common.Styles.LogCommitStatsDel.Render("-"))
454 stats[i] = strings.Join(ch[:len(ch)-1], "|") + "|" + adddel
455 }
456 }
457 return wrap.String(strings.Join(stats, "\n"), l.common.Width-2)
458}
459
460func (l *Log) renderDiff(diff *ggit.Diff) string {
461 var s strings.Builder
462 var pr strings.Builder
463 diffChroma := &gansi.CodeBlockElement{
464 Code: diff.Patch(),
465 Language: "diff",
466 }
467 err := diffChroma.Render(&pr, renderCtx())
468 if err != nil {
469 s.WriteString(fmt.Sprintf("\n%s", err.Error()))
470 } else {
471 s.WriteString(fmt.Sprintf("\n%s", pr.String()))
472 }
473 return wrap.String(s.String(), l.common.Width-2)
474}