/
summary.go
669 lines (604 loc) · 18.6 KB
/
summary.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
package workflow
import (
"fmt"
"io"
"log"
"regexp"
"sort"
"strconv"
"strings"
"time"
"github.com/clarsen/trello"
"gopkg.in/yaml.v2"
)
// TaskInfo defines what a task looks like -- just reflects what's currenty in trello.
type TaskInfo struct {
CreatedDate string `yaml:"createdDate"`
DoneDate string `yaml:"doneDate"`
Title string `yaml:"title"`
}
// WeeklyGoalInfo defines what a weekly goal looks like
type WeeklyGoalInfo struct {
Title string `yaml:"title"`
Created string `yaml:"createdDate"`
Status string `yaml:"status"`
Week int `yaml:"weekNumber"`
Year int `yaml:"year"`
}
// MonthlyGoalInfo defines what a monthly goal looks like - a title, when it was
// created and a list of weekly goals.
type MonthlyGoalInfo struct {
Title string `yaml:"title"`
Created string `yaml:"createdDate"`
WeeklyGoals []WeeklyGoalInfo `yaml:"weeklyGoals"`
}
// WeeklySummary defines the summarization data that is dumped for downstream
// consumption independent of task management tool (in this case Trello).
type WeeklySummary struct {
Year int `yaml:"year"`
Month int `yaml:"month"`
Week int `yaml:"weekNumber"`
Done []TaskInfo `yaml:"doneThisWeek"`
MonthlyGoals []MonthlyGoalInfo `yaml:"monthlyGoals"`
MonthlySprints []MonthlyGoalInfo `yaml:"monthlySprints"`
}
// WeeklySummaryItems is array of feedback from a particular week
type WeeklySummaryItems struct {
Week int `yaml:"week"`
Content []string `yaml:"content"`
}
// PerGoalWeeklySummaryItems is array of feedback from a particular week for a particular goal
type PerGoalWeeklySummaryItems struct {
Goal string `yaml:"goal"`
DidToCreateOutcome []WeeklySummaryItems `yaml:"didToCreateOutcome"`
KeepDoing []WeeklySummaryItems `yaml:"keepDoing"`
DoDifferently []WeeklySummaryItems `yaml:"doDifferently"`
}
// MonthlySummary defines the summarization data that is dumped for downstream
// consumption independent of task management tool (in this case Trello).
//
// for monthly summary, monthly goal and monthly sprint info will merge together
// weekly goals
type MonthlySummary struct {
Year int `yaml:"year"`
Month int `yaml:"month"`
WeeksOfYear string `yaml:"weeksOfYear"`
MonthlyGoals []MonthlyGoalInfo `yaml:"monthlyGoals"`
MonthlySprints []MonthlyGoalInfo `yaml:"monthlySprints"`
Events []string `yaml:"events"`
GoingWell []WeeklySummaryItems `yaml:"goingWell"`
NeedsImprovement []WeeklySummaryItems `yaml:"needsImprovement"`
Successes []WeeklySummaryItems `yaml:"successes"`
Challenges []WeeklySummaryItems `yaml:"challenges"`
MonthlyGoalSummaries []PerGoalWeeklySummaryItems `yaml:"monthlyGoalSummaries"`
}
// YearlySummary defines what's dumped for rolling up into the yearly plan summary
type YearlySummary struct {
Year int `yaml:"year"`
MonthlySummaries []MonthlySummary `yaml:"monthlySummaries"`
}
// WeeklyReviewData holds raw review content and extra info about the year, month, week it is from
type WeeklyReviewData struct {
Year int
Month int
Week int
Content []byte
}
func dumpMonthlyGoalInfo(card *trello.Card, weekNumber *int) (MonthlyGoalInfo, error) {
var g MonthlyGoalInfo
g.Title = card.Name
reMDY := regexp.MustCompile(`\((\d{4}-\d{2}-\d{2})\)`)
exprGoalMDY := reMDY.FindStringSubmatch(card.Name)
if len(exprGoalMDY) <= 0 {
err := fmt.Errorf("Couldn't parse date out of title %s", card.Name)
return g, err
}
g.Created = exprGoalMDY[1]
re := regexp.MustCompile(`^week (\d+): (.*) (?:\((\d{4}-\d{2}-\d{2})\))(?: (\(.*\)))?$`)
reYear := regexp.MustCompile(`^(\d{4})-\d{2}-\d{2}$`)
for _, cl := range card.Checklists {
// log.Println("checklist:", cl)
for _, item := range cl.CheckItems {
expr := re.FindStringSubmatch(item.Name)
if len(expr) > 0 {
// log.Printf("for %s got match %+v\n", item.Name, expr)
// log.Println("got week", expr[1])
// log.Println("got text", expr[2])
// log.Println("got created", expr[3])
// log.Println("got status", expr[4])
week, err := strconv.Atoi(expr[1])
if weekNumber != nil && week != *weekNumber {
continue
}
if err != nil {
return g, err
}
text := expr[2]
created := expr[3]
exprYear := reYear.FindStringSubmatch(created)
if len(exprYear) <= 0 {
continue
}
year, err := strconv.Atoi(exprYear[1])
if err != nil {
return g, err
}
status := expr[4]
wgi := WeeklyGoalInfo{
Year: year,
Week: week,
Created: created,
Title: text,
Status: status,
}
g.WeeklyGoals = append(g.WeeklyGoals, wgi)
}
}
}
return g, nil
}
func dumpSummaryForWeek(
summary *WeeklySummary,
out io.Writer,
) error {
buf, err := yaml.Marshal(summary)
if err != nil {
log.Fatal(err)
}
_, err = out.Write(buf)
return err
}
func generateWeeklySummary(
year, week, month int,
doneCards, goalCards, sprintCards []*trello.Card,
) (
*WeeklySummary, error,
) {
summary := WeeklySummary{}
summary.Year = year
summary.Week = week
summary.Month = month
local, err := time.LoadLocation("America/Los_Angeles")
if err != nil {
return nil, err
}
log.Printf("generateWeeklySummary - %+v doneCards\n", len(doneCards))
for _, card := range doneCards {
actions, err2 := card.GetActions(trello.Arguments{"filter": "copyCard,updateCard:idList,moveCardToBoard"})
if err2 != nil {
return nil, err2
}
var latest *time.Time
for _, a := range actions {
if latest == nil || a.Date.After(*latest) {
latest = &a.Date
}
}
// well, unfortunately, Trello loses action data after a while when moving
// card to another board, so the last action may only be the time when it
// was moved to the history board and no actions when in a previous board.
var doneDate string
if latest == nil {
doneDate = "unknown"
} else {
doneDate = latest.In(local).Format("2006-01-02 (Mon)")
}
summary.Done = append(summary.Done, TaskInfo{
DoneDate: doneDate,
Title: card.Name,
CreatedDate: card.CreatedAt().In(local).Format("2006-01-02"),
})
}
for _, goalCard := range goalCards {
dmgi, err2 := dumpMonthlyGoalInfo(goalCard, &summary.Week)
if err2 != nil {
return nil, err2
}
summary.MonthlyGoals = append(summary.MonthlyGoals, dmgi)
}
for _, sprintCard := range sprintCards {
dmsi, err2 := dumpMonthlyGoalInfo(sprintCard, &summary.Week)
if err2 != nil {
return nil, err2
}
summary.MonthlySprints = append(summary.MonthlySprints, dmsi)
}
return &summary, nil
}
func prepareSummaryForWeek(
user, appkey, authtoken string,
year, week int,
) (
month int,
doneCards, goalCards, sprintCards []*trello.Card,
err error) {
cl, err := New(user, appkey, authtoken)
if err != nil {
log.Fatal(err)
}
doneList, err := ListFor(cl, "Kanban daily/weekly", "Done this week")
if err != nil {
return
}
doneCards, err = doneList.GetCards(trello.Defaults())
if err != nil {
// handle error
return
}
monthlyGoalsList, err := ListFor(cl, "Kanban daily/weekly", "Monthly Goals")
if err != nil {
return
}
goalCards, err = monthlyGoalsList.GetCards(trello.Arguments{"fields": "all"})
if err != nil {
// handle error
return
}
monthlySprintsList, err := ListFor(cl, "Kanban daily/weekly", "Monthly Sprints")
if err != nil {
return
}
sprintCards, err = monthlySprintsList.GetCards(trello.Arguments{"fields": "all"})
if err != nil {
// handle error
return
}
type MonthForWeek struct {
year int
month int
weekBegin int
weekEnd int
}
// Monthly reviews don't always fall strictly after the end of the month.
monthForWeekYearRange := []MonthForWeek{
{2018, 1, 1, 4},
{2018, 2, 5, 9},
{2018, 3, 10, 13},
{2018, 4, 14, 17},
{2018, 5, 18, 22},
{2018, 6, 23, 26},
{2018, 7, 27, 30},
{2018, 8, 31, 35},
{2018, 9, 36, 39},
{2018, 10, 40, 44},
{2018, 11, 45, 48},
{2018, 12, 49, 52},
{2019, 1, 1, 5},
{2019, 2, 6, 9},
{2019, 3, 10, 13},
{2019, 4, 14, 17},
{2019, 5, 18, 22},
{2019, 6, 23, 26},
{2019, 7, 27, 31},
{2019, 8, 32, 35},
{2019, 9, 36, 39},
{2019, 10, 40, 44},
{2019, 11, 45, 48},
{2019, 12, 49, 52},
{2020, 1, 1, 5},
{2020, 2, 6, 9},
{2020, 3, 10, 13},
{2020, 4, 14, 18},
{2020, 5, 19, 22},
{2020, 6, 23, 26},
{2020, 7, 27, 31},
{2020, 8, 32, 35},
{2020, 9, 36, 40},
{2020, 10, 41, 44},
{2020, 11, 45, 48},
{2020, 12, 49, 53},
{2021, 1, 1, 4},
{2021, 2, 5, 8},
{2021, 3, 9, 13},
{2021, 4, 14, 17},
{2021, 5, 18, 21},
{2021, 6, 22, 26},
{2021, 7, 27, 30},
{2021, 8, 31, 35},
{2021, 9, 36, 39},
{2021, 10, 40, 43},
{2021, 11, 44, 48},
{2021, 12, 49, 52},
}
// Although this would allow us to do review on monday or tuesday instead of
// just sunday, shifting back -3 days results in daily email not reporting on
// upcoming week until wednesday.
// XXX: should make week an external parameter
// year, week = time.Now().ISOWeek()
month = 0
for _, ymw := range monthForWeekYearRange {
if year == ymw.year && week >= ymw.weekBegin && week <= ymw.weekEnd {
month = ymw.month
break
}
}
// month = int(time.Now().Month())
if month == 0 {
log.Fatalf("no month mapping for year %d week %d", year, week)
}
return month, doneCards, goalCards, sprintCards, nil
}
// GetSummaryForWeek returns a summary structure usable by other downstream
// in-memory pipelines like daily reminder.
func GetSummaryForWeek(user, appkey, authtoken string, year, week int) (*WeeklySummary, error) {
// XXX: should make week an external parameter so email reminder can obey calendar
month, doneCards, goalCards, sprintCards, err := prepareSummaryForWeek(user, appkey, authtoken, year, week)
if err != nil {
return nil, err
}
return generateWeeklySummary(year, week, month, doneCards, goalCards, sprintCards)
}
// DumpSummaryForWeek dumps current content of Trello board to summary file for week
func DumpSummaryForWeek(user, appkey, authtoken string, year, week int, out io.Writer) error {
// XXX: should make week an external parameter so review can lag a bit into the week
month, doneCards, goalCards, sprintCards, err := prepareSummaryForWeek(user, appkey, authtoken, year, week)
if err != nil {
return err
}
summary, err := generateWeeklySummary(year, week, month, doneCards, goalCards, sprintCards)
if err != nil {
return err
}
return dumpSummaryForWeek(summary, out)
}
func mergeMonthlyGoalInfo(goalsAcrossWeeks []MonthlyGoalInfo) []MonthlyGoalInfo {
allWeeklyGoals := map[string][]WeeklyGoalInfo{}
created := map[string]string{}
for _, mg := range goalsAcrossWeeks {
allWeeklyGoals[mg.Title] = append(allWeeklyGoals[mg.Title], mg.WeeklyGoals...)
created[mg.Title] = mg.Created
}
var monthlyGoals []MonthlyGoalInfo
var titles []string
for title := range allWeeklyGoals {
titles = append(titles, title)
}
sort.Strings(titles)
for _, title := range titles {
goals := allWeeklyGoals[title]
mg := MonthlyGoalInfo{Title: title,
Created: created[title],
WeeklyGoals: goals,
}
monthlyGoals = append(monthlyGoals, mg)
}
return monthlyGoals
}
func arrayToString(a []int, delim string) string {
return strings.Trim(strings.Replace(fmt.Sprint(a), " ", delim, -1), "[]")
//return strings.Trim(strings.Join(strings.Split(fmt.Sprint(a), " "), delim), "[]")
//return strings.Trim(strings.Join(strings.Fields(fmt.Sprint(a)), delim), "[]")
}
// GenerateSummaryForMonth rolls up weekly summaries to month level
func GenerateSummaryForMonth(user, appkey, authtoken string, year, month int, summaryIn [][]byte, reviewIn []WeeklyReviewData, out io.Writer) error {
cl, err := New(user, appkey, authtoken)
if err != nil {
log.Fatal(err)
}
eventsList, err := ListFor(cl, "Kanban daily/weekly", "Upcoming events")
if err != nil {
return err
}
eventCards, err := eventsList.GetCards(trello.Defaults())
if err != nil {
// handle error
return err
}
_ = eventCards
summary := MonthlySummary{}
summary.Year = year
summary.Month = month
// events
// parse out event info, limit to particular month
re := regexp.MustCompile(`^((?:\?|X)?\s*)(\d+)/(\d+)(?:/(\d+))?(?:-(\d+/\d+)(?:/(\d+))?)? (.*)$`)
for _, event := range eventCards {
expr := re.FindStringSubmatch(event.Name)
if len(expr) > 0 {
log.Printf("for %s got match %+v\n", event.Name, expr)
// log.Println("got (opt) maybe/didn't do", expr[1])
// log.Println("got month", expr[2])
// log.Println("got day", expr[3])
// log.Println("got (opt) year", expr[4])
// log.Println("got (opt) end date", expr[5])
// log.Println("got (opt) end date year", expr[6])
// log.Println("got details", expr[7])
mon, err2 := strconv.Atoi(expr[2])
if err2 != nil {
log.Println("error parsing month in", event.Name)
summary.Events = append(summary.Events, event.Name)
continue
}
if mon == month {
summary.Events = append(summary.Events, event.Name)
}
} else {
log.Printf("%s didn't parse\n", event.Name)
summary.Events = append(summary.Events, event.Name)
}
}
var weeklies []WeeklySummary
var weeknums = []int{}
for _, buf := range summaryIn {
var weekly WeeklySummary
err2 := yaml.Unmarshal(buf, &weekly)
if err2 != nil {
log.Fatal(err2)
return err2
}
if weekly.Year == year && weekly.Month == month {
weeklies = append(weeklies, weekly)
weeknums = append(weeknums, weekly.Week)
}
}
summary.WeeksOfYear = arrayToString(weeknums, ",")
var goingWell []WeeklySummaryItems
var needsImprovement []WeeklySummaryItems
var successes []WeeklySummaryItems
var challenges []WeeklySummaryItems
goalReviews := make(map[string]PerGoalWeeklySummaryItems)
for _, wrd := range reviewIn {
var weekly WeeklyReview
err2 := yaml.Unmarshal(wrd.Content, &weekly)
if err2 != nil {
log.Println(string(wrd.Content))
log.Fatal(err2)
return err2
}
if wrd.Year == year && wrd.Month == month {
goingWell = append(goingWell, WeeklySummaryItems{
Week: wrd.Week,
Content: weekly.GoingWell,
})
needsImprovement = append(needsImprovement, WeeklySummaryItems{
Week: wrd.Week,
Content: weekly.NeedsImprovement,
})
successes = append(successes, WeeklySummaryItems{
Week: wrd.Week,
Content: weekly.Successes,
})
challenges = append(challenges, WeeklySummaryItems{
Week: wrd.Week,
Content: weekly.Challenges,
})
for _, goal := range weekly.PerGoalReviews {
var title string
var ginfo PerGoalWeeklySummaryItems
if len(goal.DidToCreateOutcome) == 0 {
title = "no goal specified"
ginfo = goalReviews[title]
ginfo.Goal = title
} else {
title = goal.DidToCreateOutcome[0]
ginfo = goalReviews[title]
ginfo.Goal = title
ginfo.DidToCreateOutcome = append(ginfo.DidToCreateOutcome, WeeklySummaryItems{
Week: wrd.Week,
Content: goal.DidToCreateOutcome[1:],
})
}
if len(goal.KeepDoing) > 0 {
ginfo.KeepDoing = append(ginfo.KeepDoing, WeeklySummaryItems{
Week: wrd.Week,
Content: goal.KeepDoing,
})
}
if len(goal.DoDifferently) > 0 {
ginfo.DoDifferently = append(ginfo.DoDifferently, WeeklySummaryItems{
Week: wrd.Week,
Content: goal.DoDifferently,
})
}
goalReviews[title] = ginfo
}
}
}
if len(weeklies) > 0 {
var allMonthlyGoals []MonthlyGoalInfo
for _, ws := range weeklies {
allMonthlyGoals = append(allMonthlyGoals, ws.MonthlyGoals...)
}
summary.MonthlyGoals = mergeMonthlyGoalInfo(allMonthlyGoals)
allMonthlyGoals = []MonthlyGoalInfo{}
for _, ws := range weeklies {
allMonthlyGoals = append(allMonthlyGoals, ws.MonthlySprints...)
}
summary.MonthlySprints = mergeMonthlyGoalInfo(allMonthlyGoals)
// log.Printf("filtered to %+v\n", weeklies)
summary.GoingWell = goingWell
summary.NeedsImprovement = needsImprovement
summary.Successes = successes
summary.Challenges = challenges
for _, gs := range goalReviews {
summary.MonthlyGoalSummaries = append(summary.MonthlyGoalSummaries, gs)
}
}
buf, err := yaml.Marshal(summary)
if err != nil {
log.Fatal(err)
}
_, err = out.Write(buf)
return err
}
// GenerateSummaryForYear rolls up monthly summaries to year level
func GenerateSummaryForYear(year int, summaryIn [][]byte, out io.Writer) error {
var monthlies []MonthlySummary
for _, buf := range summaryIn {
var monthly MonthlySummary
err := yaml.Unmarshal(buf, &monthly)
if err != nil {
return err
}
monthlies = append(monthlies, monthly)
}
if len(monthlies) <= 0 {
return fmt.Errorf("No summaries for %d", year)
}
summary := YearlySummary{Year: year}
for _, m := range monthlies {
summary.MonthlySummaries = append(summary.MonthlySummaries, m)
}
buf, err := yaml.Marshal(summary)
if err != nil {
log.Fatal(err)
}
_, err = out.Write(buf)
return err
}
// DumpSummaryForWeekFromHistory dumps current content of Trello history board to summary file for week
func DumpSummaryForWeekFromHistory(user, appkey, authtoken string, week int, out io.Writer) error {
cl, err := New(user, appkey, authtoken)
if err != nil {
log.Fatal(err)
}
months := []string{"January", "February", "March", "April",
"May", "June", "July", "August", "September", "October",
"November", "December",
}
var doneCards, goalCards, sprintCards []*trello.Card
for idx, month := range months {
olderMonthlyDoneList, err := ListFor(cl, "History 2018", fmt.Sprintf("%02d %s", week, month))
if err != nil {
return err
}
if olderMonthlyDoneList == nil {
continue
}
doneCards, err = olderMonthlyDoneList.GetCards(trello.Defaults())
if err != nil {
return err
}
monthlyGoalsList, err := ListFor(cl, "History 2018", fmt.Sprintf("%02d %s goals", week, month))
if err != nil {
return err
}
goalCards, err = monthlyGoalsList.GetCards(trello.Arguments{"fields": "all"})
if err != nil {
// handle error
return err
}
var monthlySprintsList *trello.List
if week >= 5 {
// for the one-off capture, we're mid-february where there is no sprints
// list (only created at monthly review)
monthlySprintsList, err = ListFor(cl, "Kanban daily/weekly", "Monthly Sprints")
} else {
monthlySprintsList, err = ListFor(cl, "History 2018", fmt.Sprintf("%s sprints", month))
}
if err != nil {
return err
}
sprintCards, err = monthlySprintsList.GetCards(trello.Arguments{"fields": "all"})
if err != nil {
// handle error
return err
}
summary, err := generateWeeklySummary(2018, week, idx+1, doneCards, goalCards, sprintCards)
if err != nil {
return err
}
return dumpSummaryForWeek(summary, out)
}
// doesn't reach here
return nil
}