harvest

Documentation

Index

• func CheckOptionalEnvVariables() error
• func CheckRequiredEnvVariables() error
• func DownloadAndOutputEntries(verboseFlag bool, outputFilename string) error
• func Group(verboseFlag bool, inputFlag string, outputFlag string, skipUnknown bool) error
• type CSVFormatter
  • func NewCSVFormatter(stats *Stats) *CSVFormatter
  • func (f *CSVFormatter) Output()
• type EntryMatcher
• type OutputFormat
• type PatternEntryMatcher
  • func NewPatternEntryMatcher(pattern string) (*PatternEntryMatcher, error)
  • func (m *PatternEntryMatcher) Match(text string) (bool, string)
• type Report
  • func NewReport(timeEntries []*harvest.TimeEntry, matcher EntryMatcher, skipUnknown bool) Report
  • func (r *Report) Run()
  • func (r *Report) Stats() *Stats
• type ReportInterface
• type Result
• type Stats
  • func NewStats(grouped_by_tags map[string]float64) *Stats
  • func (s *Stats) PercentageForTag(tag string) float64
  • func (s *Stats) TotalHours() float64
• type TagEntryMatcher
  • func NewTagEntryMatcher(tags string) *TagEntryMatcher
  • func (m *TagEntryMatcher) Match(text string) (bool, string)
• type TextFormatter
  • func NewTextFormatter(stats *Stats) *TextFormatter
  • func (f *TextFormatter) Output()

Functions

func CheckOptionalEnvVariables

func CheckOptionalEnvVariables() error

func CheckRequiredEnvVariables

func CheckRequiredEnvVariables() error

func DownloadAndOutputEntries

func DownloadAndOutputEntries(verboseFlag bool, outputFilename string) error

func Group

func Group(verboseFlag bool, inputFlag string, outputFlag string, skipUnknown bool) error

Types

type CSVFormatter

type CSVFormatter struct {
	Stats *Stats
}

func NewCSVFormatter

func NewCSVFormatter(stats *Stats) *CSVFormatter

func (*CSVFormatter) Output

func (f *CSVFormatter) Output()

type EntryMatcher

type EntryMatcher interface {
	Match(string) (bool, string)
}

type OutputFormat

type OutputFormat uint32

const (
	TextOutputFormat OutputFormat = iota
	CSVOutputFormat
)

type PatternEntryMatcher

type PatternEntryMatcher struct {
	// contains filtered or unexported fields
}

func NewPatternEntryMatcher

func NewPatternEntryMatcher(pattern string) (*PatternEntryMatcher, error)

func (*PatternEntryMatcher) Match

func (m *PatternEntryMatcher) Match(text string) (bool, string)

type Report

type Report struct {
	TimeEntries []*harvest.TimeEntry
	// contains filtered or unexported fields
}

func NewReport

func NewReport(timeEntries []*harvest.TimeEntry, matcher EntryMatcher, skipUnknown bool) Report

func (*Report) Run

func (r *Report) Run()

func (*Report) Stats

func (r *Report) Stats() *Stats

type ReportInterface

type ReportInterface interface {
	Output()
}

type Result

type Result struct {
	GroupedByTag map[string]float64
}

type Stats

type Stats struct {
	GroupedByTag map[string]float64
	// contains filtered or unexported fields
}

func NewStats

func NewStats(grouped_by_tags map[string]float64) *Stats

func (*Stats) PercentageForTag

func (s *Stats) PercentageForTag(tag string) float64

Returns percentage for total hours.

The hard part is to calculate percentage values so that the summed up percentages are not higher than 100%. See for example https://revs.runtime-revolution.com/getting-100-with-rounded-percentages-273ffa70252b Let's go with a simple solution that can calculate sum(percentages) > 100%.

func (*Stats) TotalHours

func (s *Stats) TotalHours() float64

type TagEntryMatcher

type TagEntryMatcher struct {
	// contains filtered or unexported fields
}

func NewTagEntryMatcher

func NewTagEntryMatcher(tags string) *TagEntryMatcher

func (*TagEntryMatcher) Match

func (m *TagEntryMatcher) Match(text string) (bool, string)

type TextFormatter

type TextFormatter struct {
	Stats *Stats
}

func NewTextFormatter

func NewTextFormatter(stats *Stats) *TextFormatter

func (*TextFormatter) Output

func (f *TextFormatter) Output()