git-bug/commands/show.go

package commands

import (
	"encoding/json"
	"errors"
	"fmt"
	"github.com/MichaelMure/git-bug/bug"
	"github.com/MichaelMure/git-bug/cache"
	_select "github.com/MichaelMure/git-bug/commands/select"
	"github.com/MichaelMure/git-bug/util/colors"
	"github.com/MichaelMure/git-bug/util/interrupt"
	"github.com/spf13/cobra"
	"strings"
	"time"
)

var (
	showFieldsQuery  string
	showOutputFormat string
)

func runShowBug(_ *cobra.Command, args []string) error {
	backend, err := cache.NewRepoCache(repo)
	if err != nil {
		return err
	}
	defer backend.Close()
	interrupt.RegisterCleaner(backend.Close)

	b, args, err := _select.ResolveBug(backend, args)
	if err != nil {
		return err
	}

	snapshot := b.Snapshot()

	if len(snapshot.Comments) == 0 {
		return errors.New("invalid bug: no comment")
	}

	if showFieldsQuery != "" {
		switch showFieldsQuery {
		case "author":
			fmt.Printf("%s\n", snapshot.Author.DisplayName())
		case "authorEmail":
			fmt.Printf("%s\n", snapshot.Author.Email())
		case "createTime":
			fmt.Printf("%s\n", snapshot.CreatedAt.String())
		case "lastEdit":
			fmt.Printf("%s\n", snapshot.LastEditTime().String())
		case "humanId":
			fmt.Printf("%s\n", snapshot.Id().Human())
		case "id":
			fmt.Printf("%s\n", snapshot.Id())
		case "labels":
			for _, l := range snapshot.Labels {
				fmt.Printf("%s\n", l.String())
			}
		case "actors":
			for _, a := range snapshot.Actors {
				fmt.Printf("%s\n", a.DisplayName())
			}
		case "participants":
			for _, p := range snapshot.Participants {
				fmt.Printf("%s\n", p.DisplayName())
			}
		case "shortId":
			fmt.Printf("%s\n", snapshot.Id().Human())
		case "status":
			fmt.Printf("%s\n", snapshot.Status)
		case "title":
			fmt.Printf("%s\n", snapshot.Title)
		default:
			return fmt.Errorf("\nUnsupported field: %s\n", showFieldsQuery)
		}

		return nil
	}

	switch showOutputFormat {
	case "org-mode":
		return showOrgmodeFormatter(snapshot)
	case "json":
		return showJsonFormatter(snapshot)
	case "plain":
		return showPlainFormatter(snapshot)
	case "default":
		return showDefaultFormatter(snapshot)
	default:
		return fmt.Errorf("unknown format %s", showOutputFormat)
	}
}

func showDefaultFormatter(snapshot *bug.Snapshot) error {
	// Header
	fmt.Printf("%s [%s] %s\n\n",
		colors.Cyan(snapshot.Id().Human()),
		colors.Yellow(snapshot.Status),
		snapshot.Title,
	)

	fmt.Printf("%s opened this issue %s\n",
		colors.Magenta(snapshot.Author.DisplayName()),
		snapshot.CreatedAt.String(),
	)

	fmt.Printf("This was last edited at %s\n\n",
		snapshot.LastEditTime().String(),
	)

	// Labels
	var labels = make([]string, len(snapshot.Labels))
	for i := range snapshot.Labels {
		labels[i] = string(snapshot.Labels[i])
	}

	fmt.Printf("labels: %s\n",
		strings.Join(labels, ", "),
	)

	// Actors
	var actors = make([]string, len(snapshot.Actors))
	for i := range snapshot.Actors {
		actors[i] = snapshot.Actors[i].DisplayName()
	}

	fmt.Printf("actors: %s\n",
		strings.Join(actors, ", "),
	)

	// Participants
	var participants = make([]string, len(snapshot.Participants))
	for i := range snapshot.Participants {
		participants[i] = snapshot.Participants[i].DisplayName()
	}

	fmt.Printf("participants: %s\n\n",
		strings.Join(participants, ", "),
	)

	// Comments
	indent := "  "

	for i, comment := range snapshot.Comments {
		var message string
		fmt.Printf("%s#%d %s <%s>\n\n",
			indent,
			i,
			comment.Author.DisplayName(),
			comment.Author.Email(),
		)

		if comment.Message == "" {
			message = colors.GreyBold("No description provided.")
		} else {
			message = comment.Message
		}

		fmt.Printf("%s%s\n\n\n",
			indent,
			message,
		)
	}

	return nil
}

func showPlainFormatter(snapshot *bug.Snapshot) error {
	// Header
	fmt.Printf("%s [%s] %s\n",
		snapshot.Id().Human(),
		snapshot.Status,
		snapshot.Title,
	)

	fmt.Printf("author: %s\n",
		snapshot.Author.DisplayName(),
	)

	fmt.Printf("creation time: %s\n",
		snapshot.CreatedAt.String(),
	)

	fmt.Printf("last edit: %s\n",
		snapshot.LastEditTime().String(),
	)

	// Labels
	var labels = make([]string, len(snapshot.Labels))
	for i := range snapshot.Labels {
		labels[i] = string(snapshot.Labels[i])
	}

	fmt.Printf("labels: %s\n",
		strings.Join(labels, ", "),
	)

	// Actors
	var actors = make([]string, len(snapshot.Actors))
	for i := range snapshot.Actors {
		actors[i] = snapshot.Actors[i].DisplayName()
	}

	fmt.Printf("actors: %s\n",
		strings.Join(actors, ", "),
	)

	// Participants
	var participants = make([]string, len(snapshot.Participants))
	for i := range snapshot.Participants {
		participants[i] = snapshot.Participants[i].DisplayName()
	}

	fmt.Printf("participants: %s\n",
		strings.Join(participants, ", "),
	)

	// Comments
	indent := "  "

	for i, comment := range snapshot.Comments {
		var message string
		fmt.Printf("%s#%d %s <%s>\n",
			indent,
			i,
			comment.Author.DisplayName(),
			comment.Author.Email(),
		)

		if comment.Message == "" {
			message = "No description provided."
		} else {
			message = comment.Message
		}

		fmt.Printf("%s%s\n",
			indent,
			strings.ReplaceAll(message, "\n", fmt.Sprintf("\n%s", indent)),
		)
	}

	return nil
}

type JSONBugSnapshot struct {
	Id           string    `json:"id"`
	HumanId      string    `json:"human_id"`
	CreationTime time.Time `json:"creation_time"`
	LastEdited   time.Time `json:"last_edited"`

	Status       string         `json:"status"`
	Labels       []bug.Label    `json:"labels"`
	Title        string         `json:"title"`
	Author       JSONIdentity   `json:"author"`
	Actors       []JSONIdentity `json:"actors"`
	Participants []JSONIdentity `json:"participants"`

	Comments []JSONComment `json:"comments"`
}

type JSONComment struct {
	Id          int    `json:"id"`
	AuthorName  string `json:"author_name"`
	AuthorLogin string `json:"author_login"`
	Message     string `json:"message"`
}

func showJsonFormatter(snapshot *bug.Snapshot) error {
	jsonBug := JSONBugSnapshot{
		snapshot.Id().String(),
		snapshot.Id().Human(),
		snapshot.CreatedAt,
		snapshot.LastEditTime(),
		snapshot.Status.String(),
		snapshot.Labels,
		snapshot.Title,
		JSONIdentity{},
		[]JSONIdentity{},
		[]JSONIdentity{},
		[]JSONComment{},
	}

	author, err := NewJSONIdentity(snapshot.Author)
	if err != nil {
		return err
	}
	jsonBug.Author = author

	for _, element := range snapshot.Actors {
		actor, err := NewJSONIdentity(element)
		if err != nil {
			return err
		}
		jsonBug.Actors = append(jsonBug.Actors, actor)
	}

	for _, element := range snapshot.Participants {
		participant, err := NewJSONIdentity(element)
		if err != nil {
			return err
		}
		jsonBug.Participants = append(jsonBug.Participants, participant)
	}

	for i, comment := range snapshot.Comments {
		var message string
		if comment.Message == "" {
			message = "No description provided."
		} else {
			message = comment.Message
		}
		jsonBug.Comments = append(jsonBug.Comments, JSONComment{
			i,
			comment.Author.Name(),
			comment.Author.Login(),
			message,
		})
	}

	jsonObject, _ := json.MarshalIndent(jsonBug, "", "    ")
	fmt.Printf("%s\n", jsonObject)

	return nil
}

func showOrgmodeFormatter(snapshot *bug.Snapshot) error {
	// Header
	fmt.Printf("%s [%s] %s\n",
		snapshot.Id().Human(),
		snapshot.Status,
		snapshot.Title,
	)

	fmt.Printf("* Author: %s\n",
		snapshot.Author.DisplayName(),
	)

	fmt.Printf("* Creation Time: %s\n",
		snapshot.CreatedAt.String(),
	)

	fmt.Printf("* Last Edit: %s\n",
		snapshot.LastEditTime().String(),
	)

	// Labels
	var labels = make([]string, len(snapshot.Labels))
	for i, label := range snapshot.Labels {
		labels[i] = string(label)
	}

	fmt.Printf("* Labels:\n")
	if len(labels) > 0 {
		fmt.Printf("** %s", strings.TrimSuffix(strings.Join(labels, "\n **"), "\n **"))
	}

	// Actors
	var actors = make([]string, len(snapshot.Actors))
	for i, actor := range snapshot.Actors {
		actors[i] = fmt.Sprintf("%s %s",
			actor.Id().Human(),
			actor.DisplayName(),
		)
	}

	fmt.Printf("* Actors: %s\n",
		strings.TrimSuffix(strings.Join(actors, "\n **"), "\n **"),
	)

	// Participants
	var participants = make([]string, len(snapshot.Participants))
	for i, participant := range snapshot.Participants {
		actors[i] = fmt.Sprintf("%s %s",
			participant.Id().Human(),
			participant.DisplayName(),
		)
	}

	fmt.Printf("* Participants: %s\n",
		strings.TrimSuffix(strings.Join(participants, "\n **"), "\n **"),
	)

	fmt.Printf("* Comments:\n")

	for i, comment := range snapshot.Comments {
		var message string
		fmt.Printf("** #%d %s [%s]\n",
			i,
			comment.Author.DisplayName(),
		)

		if comment.Message == "" {
			message = "No description provided."
		} else {
			message = strings.ReplaceAll(comment.Message, "\n", "\n: ")
		}

		fmt.Printf(": %s\n",
			message,
		)
	}

	return nil
}

var showCmd = &cobra.Command{
	Use:     "show [<id>]",
	Short:   "Display the details of a bug.",
	PreRunE: loadRepo,
	RunE:    runShowBug,
}

func init() {
	RootCmd.AddCommand(showCmd)
	showCmd.Flags().StringVarP(&showFieldsQuery, "field", "", "",
		"Select field to display. Valid values are [author,authorEmail,createTime,lastEdit,humanId,id,labels,shortId,status,title,actors,participants]")
	showCmd.Flags().StringVarP(&showOutputFormat, "format", "f", "default",
		"Select the output formatting style. Valid values are [default,plain,json,org-mode]")
}