glow/ui/stash.go

package ui

import (
	"fmt"
	"sort"
	"strconv"
	"strings"

	"github.com/charmbracelet/boba"
	"github.com/charmbracelet/boba/paginator"
	"github.com/charmbracelet/boba/spinner"
	"github.com/charmbracelet/charm"
	"github.com/charmbracelet/charm/ui/common"
	"github.com/muesli/reflow/indent"
	te "github.com/muesli/termenv"
)

const (
	stashViewItemHeight    = 3
	stashViewTopPadding    = 5
	stashViewBottomPadding = 4
	stashHorizontalPadding = 6
)

// MSG

type stashErrMsg error
type stashSpinnerTickMsg struct{}
type gotStashMsg []*charm.Markdown
type gotStashedItemMsg *charm.Markdown
type deletedStashedItemMsg int

// MODEL

type stashState int

const (
	stashStateInit stashState = iota
	stashStateStashLoaded
	stashStatePromptDelete
	stashStateLoadingDocument
)

type stashModel struct {
	cc             *charm.Client
	err            error
	state          stashState
	documents      []*charm.Markdown
	spinner        spinner.Model
	index          int
	terminalWidth  int
	terminalHeight int
	loading        bool // are we currently loading something?
	fullyLoaded    bool // Have we loaded everything from the server?

	// This handles the local pagination, which is different than the page
	// we're fetching from on the server side
	paginator paginator.Model

	// Page we're fetching items from on the server, which is different from
	// the local pagination. Generally, the server will return more items than
	// we can display at a time so we can paginate locally without having to
	// fetch every time.
	page int
}

func (m *stashModel) SetSize(width, height int) {
	m.terminalWidth = width
	m.terminalHeight = height

	// Update the paginator
	perPage := (m.terminalHeight - stashViewTopPadding - stashViewBottomPadding) / stashViewItemHeight
	m.paginator.PerPage = perPage
	m.paginator.SetTotalPages(len(m.documents))

	// Make sure the page stays in bounds
	if m.paginator.Page >= m.paginator.TotalPages-1 {
		m.paginator.Page = m.paginator.TotalPages - 1
	}
}

// INIT

func stashInit(cc *charm.Client) (stashModel, boba.Cmd) {
	s := spinner.NewModel()
	s.Type = spinner.Dot
	s.ForegroundColor = common.SpinnerColor
	s.CustomMsgFunc = func() boba.Msg { return stashSpinnerTickMsg{} }

	p := paginator.NewModel()
	p.Type = paginator.Dots
	p.InactiveDot = common.Subtle("•")

	m := stashModel{
		cc:        cc,
		spinner:   s,
		page:      1,
		paginator: p,
	}

	return m, boba.Batch(
		loadStash(m),
		spinner.Tick(s),
	)
}

// UPDATE

func stashUpdate(msg boba.Msg, m stashModel) (stashModel, boba.Cmd) {
	var (
		cmd  boba.Cmd
		cmds []boba.Cmd
	)

	switch msg := msg.(type) {

	case boba.KeyMsg:
		// Don't respond to keystrokes if we're still loading
		if m.state == stashStateInit {
			return m, nil
		}

		switch msg.String() {

		case "k":
			fallthrough
		case "up":
			m.index--
			if m.index < 0 && m.paginator.Page == 0 {
				// Stop
				m.index = 0
			} else if m.index < 0 {
				// Go to previous page
				m.paginator.PrevPage()
				m.index = m.paginator.ItemsOnPage(len(m.documents)) - 1
			}

		case "j":
			fallthrough
		case "down":
			itemsOnPage := m.paginator.ItemsOnPage(len(m.documents))
			m.index++
			if m.index >= itemsOnPage && m.paginator.OnLastPage() {
				// Stop
				m.index = itemsOnPage - 1
			} else if m.index >= itemsOnPage {
				// Go to next page
				m.index = 0
				m.paginator.NextPage()
			}

		case "enter":
			// Load the document from the server. We'll handle the message
			// that comes back in the main update function.
			m.state = stashStateLoadingDocument
			indexToLoad := m.paginator.Page*m.paginator.PerPage + m.index
			cmds = append(cmds,
				loadStashedItem(m.cc, m.documents[indexToLoad].ID),
				spinner.Tick(m.spinner),
			)

		case "x":
			// Confirm deletion
			m.state = stashStatePromptDelete

		case "y":
			if m.state != stashStatePromptDelete {
				break
			}
			// Deletion confirmed. Delete the stashed item.

			// Index of the documents slice we'll be deleting
			i := m.paginator.Page*m.paginator.PerPage + m.index

			// ID of the item we'll be deleting
			id := m.documents[i].ID

			// Delete optimistically and remove the stashed item
			// before we've received a success response.
			m.documents = append(m.documents[:i], m.documents[i+1:]...)

			// Update pagination
			m.paginator.SetTotalPages(len(m.documents))
			m.paginator.Page = min(m.paginator.Page, m.paginator.TotalPages-1)

			// Set state and delete
			m.state = stashStateStashLoaded
			return m, deleteStashedItem(m.cc, id)

		}

	case stashErrMsg:
		m.err = msg

	case gotStashMsg:
		// Stash results have come in from the server
		m.loading = false

		if len(msg) == 0 {
			// If the server comes back with nothing then we've got everything
			m.fullyLoaded = true
			break
		}

		sort.Sort(charm.MarkdownsByCreatedAt(msg)) // sort by date
		m.documents = append(m.documents, msg...)
		m.state = stashStateStashLoaded
		m.paginator.SetTotalPages(len(m.documents))

	case stashSpinnerTickMsg:
		if m.state == stashStateInit || m.state == stashStateLoadingDocument {
			m.spinner, cmd = spinner.Update(msg, m.spinner)
			cmds = append(cmds, cmd)
		}
	}

	if m.state == stashStateStashLoaded {

		// Update paginator
		m.paginator, cmd = paginator.Update(msg, m.paginator)
		cmds = append(cmds, cmd)

		// Keep the index in bounds when paginating
		itemsOnPage := m.paginator.ItemsOnPage(len(m.documents))
		if m.index > itemsOnPage-1 {
			m.index = itemsOnPage - 1
		}

		// If we're on the last page and we haven't loaded everything, get
		// more stuff.
		if m.paginator.OnLastPage() && !m.loading && !m.fullyLoaded {
			m.page++
			m.loading = true
			cmds = append(cmds, loadStash(m))
		}

	}

	// If an item is being confirmed for delete, any key (other than the key
	// used for confirmation above) cancels the deletion
	k, ok := msg.(boba.KeyMsg)
	if ok && k.String() != "x" && m.state == stashStatePromptDelete {
		m.state = stashStateStashLoaded
	}

	return m, boba.Batch(cmds...)
}

// VIEW

func stashView(m stashModel) string {
	if m.err != nil {
		return "\n" + m.err.Error()
	}

	var s string
	switch m.state {
	case stashStateInit:
		s += spinner.View(m.spinner) + " Loading stash..."
	case stashStateLoadingDocument:
		s += spinner.View(m.spinner) + " Loading document..."
	case stashStateStashLoaded:
		fallthrough
	case stashStatePromptDelete:
		if len(m.documents) == 0 {
			s += stashEmtpyView(m)
			break
		}

		// Blank lines we'll need to fill with newlines if the viewport is
		// properly filled
		numBlankLines := (m.terminalHeight - stashViewTopPadding - stashViewBottomPadding) % stashViewItemHeight
		blankLines := ""
		if numBlankLines > 0 {
			blankLines = strings.Repeat("\n", numBlankLines)
		}

		var header string
		if m.state == stashStatePromptDelete {
			header = te.String("Delete this item? ").Foreground(common.Red.Color()).String() +
				te.String("(y/N)").Foreground(common.FaintRed.Color()).String()
		} else {
			header = "Here’s your markdown stash:"
		}

		var pagination string
		if m.paginator.TotalPages > 1 {
			pagination = paginator.View(m.paginator)

			if !m.fullyLoaded {
				pagination += common.Subtle("···")
			}
		}

		s += fmt.Sprintf(
			"%s\n\n%s\n\n%s\n\n%s%s\n\n%s",
			glowLogoView(" Glow "),
			header,
			stashPopulatedView(m),
			blankLines,
			pagination,
			helpView(m),
		)
	}
	return "\n" + indent.String(s, 2)
}

func stashEmtpyView(m stashModel) string {
	return "Nothing stashed yet."
}

func stashPopulatedView(m stashModel) string {
	var s string

	start, end := m.paginator.GetSliceBounds(len(m.documents))
	docs := m.documents[start:end]

	for i, v := range docs {
		state := common.StateNormal
		if i == m.index && m.state == stashStatePromptDelete {
			state = common.StateDeleting
		} else if i == m.index {
			state = common.StateSelected
		}
		s += stashListItemView(*v).render(m.terminalWidth, state) + "\n\n"
	}
	s = strings.TrimSpace(s) // trim final newlines

	// If there aren't enough items to fill up this page (always the last page)
	// then we need to add some newlines to fill up the space to push the
	// footer stuff down elsewhere.
	itemsOnPage := m.paginator.ItemsOnPage(len(m.documents))
	if itemsOnPage < m.paginator.PerPage {
		n := (m.paginator.PerPage - itemsOnPage) * stashViewItemHeight
		s += strings.Repeat("\n", n)
	}

	return s
}

func helpView(m stashModel) string {
	h := []string{}
	if m.state == stashStatePromptDelete {
		h = append(h, "y: delete", "n: cancel")
	} else {
		h = append(h, "enter: open")
		if len(m.documents) > 0 {
			h = append(h, "j/k, ↑/↓: choose")
		}
		if m.paginator.TotalPages > 1 {
			h = append(h, "h/l, ←/→: page")
		}
		h = append(h, []string{"x: delete", "esc: exit"}...)
	}
	return common.HelpView(h...)
}

type stashListItemView charm.Markdown

func (m stashListItemView) render(width int, state common.State) string {

	line := common.VerticalLine(state) + " "

	keyColor := common.NoColor
	switch state {
	case common.StateSelected:
		keyColor = common.Fuschia
	case common.StateDeleting:
		keyColor = common.Red
	}

	titleKey := strconv.Itoa(m.ID)
	if m.Note != "" {
		titleKey += ":"
	}

	titleVal := truncate(m.Note, width-(stashHorizontalPadding*2)-len(titleKey))
	titleVal = titleView(titleVal, state)

	titleKey = te.String("#" + titleKey).Foreground(keyColor.Color()).String()
	dateKey := te.String("Stashed:").Foreground(keyColor.Color()).String()
	dateVal := m.date(state)

	var s string
	s += fmt.Sprintf("%s%s %s\n", line, titleKey, titleVal)
	s += fmt.Sprintf("%s%s %s", line, dateKey, dateVal)
	return s
}

func (m stashListItemView) date(state common.State) string {
	c := common.Indigo
	if state == common.StateDeleting {
		c = common.FaintRed
	}
	s := m.CreatedAt.Format("02 Jan 2006 15:04:05 MST")
	return te.String(s).Foreground(c.Color()).String()
}

func titleView(title string, state common.State) string {
	if title == "" {
		return ""
	}
	c := common.Indigo
	if state == common.StateDeleting {
		c = common.Red
	}
	return te.String(title).Foreground(c.Color()).String()
}

// CMD

func loadStash(m stashModel) boba.Cmd {
	return func() boba.Msg {
		stash, err := m.cc.GetStash(m.page)
		if err != nil {
			return stashErrMsg(err)
		}
		return gotStashMsg(stash)
	}
}

func loadStashedItem(cc *charm.Client, id int) boba.Cmd {
	return func() boba.Msg {
		m, err := cc.GetStashMarkdown(id)
		if err != nil {
			return stashErrMsg(err)
		}
		return gotStashedItemMsg(m)
	}
}

func deleteStashedItem(cc *charm.Client, id int) boba.Cmd {
	return func() boba.Msg {
		err := cc.DeleteMarkdown(id)
		if err != nil {
			return stashErrMsg(err)
		}
		return deletedStashedItemMsg(id)
	}
}

// ETC

func truncate(str string, num int) string {
	s := str
	if len(str) > num {
		if num > 1 {
			num -= 1
		}
		s = str[0:num] + "…"
	}
	return s
}