-
Notifications
You must be signed in to change notification settings - Fork 22
/
main.go
295 lines (260 loc) · 9.47 KB
/
main.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
// Package main provides the entry point for the GitHub Skyline Generator.
// It generates a 3D model of GitHub contributions in STL format.
package main
import (
"fmt"
"os"
"strconv"
"strings"
"time"
"github.com/cli/go-gh/v2/pkg/api"
"github.com/cli/go-gh/v2/pkg/browser"
"github.com/github/gh-skyline/ascii"
"github.com/github/gh-skyline/errors"
"github.com/github/gh-skyline/github"
"github.com/github/gh-skyline/logger"
"github.com/github/gh-skyline/stl"
"github.com/github/gh-skyline/types"
"github.com/spf13/cobra"
)
// Browser interface matches browser.Browser functionality
type Browser interface {
Browse(url string) error
}
// GitHubClientInterface defines the methods for interacting with GitHub API
type GitHubClientInterface interface {
GetAuthenticatedUser() (string, error)
GetUserJoinYear(username string) (int, error)
FetchContributions(username string, year int) (*types.ContributionsResponse, error)
}
// Constants for GitHub launch year and default output file format
const (
githubLaunchYear = 2008
outputFileFormat = "%s-%s-github-skyline.stl"
)
// Command line variables and root command configuration
var (
yearRange string
user string
full bool
debug bool
web bool
output string // new output path flag
rootCmd = &cobra.Command{
Use: "skyline",
Short: "Generate a 3D model of a user's GitHub contribution history",
Long: `GitHub Skyline creates 3D printable STL files from GitHub contribution data.
It can generate models for specific years or year ranges for the authenticated user or an optional specified user.
While the STL file is being generated, an ASCII preview will be displayed in the terminal.
ASCII Preview Legend:
' ' Empty/Sky - No contributions
'.' Future dates - What contributions could you make?
'░' Low level - Light contribution activity
'▒' Medium level - Moderate contribution activity
'▓' High level - Heavy contribution activity
'╻┃╽' Top level - Last block with contributions in the week (Low, Medium, High)
Layout:
Each column represents one week. Days within each week are reordered vertically
to create a "building" effect, with empty spaces (no contributions) at the top.`,
RunE: func(_ *cobra.Command, _ []string) error {
log := logger.GetLogger()
if debug {
log.SetLevel(logger.DEBUG)
if err := log.Debug("Debug logging enabled"); err != nil {
return err
}
}
client, err := initializeGitHubClient()
if err != nil {
return errors.New(errors.NetworkError, "failed to initialize GitHub client", err)
}
if web {
b := browser.New("", os.Stdout, os.Stderr)
if err := openGitHubProfile(user, client, b); err != nil {
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
os.Exit(1)
}
return nil
}
startYear, endYear, err := parseYearRange(yearRange)
if err != nil {
return fmt.Errorf("invalid year range: %v", err)
}
return generateSkyline(startYear, endYear, user, full)
},
}
)
// init sets up command line flags for the skyline CLI tool
func init() {
rootCmd.Flags().StringVarP(&yearRange, "year", "y", fmt.Sprintf("%d", time.Now().Year()), "Year or year range (e.g., 2024 or 2014-2024)")
rootCmd.Flags().StringVarP(&user, "user", "u", "", "GitHub username (optional, defaults to authenticated user)")
rootCmd.Flags().BoolVarP(&full, "full", "f", false, "Generate contribution graph from join year to current year")
rootCmd.Flags().BoolVarP(&debug, "debug", "d", false, "Enable debug logging")
rootCmd.Flags().BoolVarP(&web, "web", "w", false, "Open GitHub profile (authenticated or specified user).")
rootCmd.Flags().StringVarP(&output, "output", "o", "", "Output file path (optional)")
}
// main initializes and executes the root command for the GitHub Skyline CLI
func main() {
if err := rootCmd.Execute(); err != nil {
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
os.Exit(1)
}
}
// formatYearRange returns a formatted string representation of the year range
func formatYearRange(startYear, endYear int) string {
if startYear == endYear {
return fmt.Sprintf("%d", startYear)
}
return fmt.Sprintf("%02d-%02d", startYear%100, endYear%100)
}
// generateOutputFilename creates a consistent filename for the STL output
func generateOutputFilename(user string, startYear, endYear int) string {
if output != "" {
// Ensure the filename ends with .stl
if !strings.HasSuffix(strings.ToLower(output), ".stl") {
return output + ".stl"
}
return output
}
yearStr := formatYearRange(startYear, endYear)
return fmt.Sprintf(outputFileFormat, user, yearStr)
}
// generateSkyline creates a 3D model with ASCII art preview of GitHub contributions for the specified year range, or "full lifetime" of the user
func generateSkyline(startYear, endYear int, targetUser string, full bool) error {
log := logger.GetLogger()
client, err := initializeGitHubClient()
if err != nil {
return errors.New(errors.NetworkError, "failed to initialize GitHub client", err)
}
if targetUser == "" {
if err := log.Debug("No target user specified, using authenticated user"); err != nil {
return err
}
username, err := client.GetAuthenticatedUser()
if err != nil {
return errors.New(errors.NetworkError, "failed to get authenticated user", err)
}
targetUser = username
}
if full {
joinYear, err := client.GetUserJoinYear(targetUser)
if err != nil {
return errors.New(errors.NetworkError, "failed to get user join year", err)
}
startYear = joinYear
endYear = time.Now().Year()
}
var allContributions [][][]types.ContributionDay
for year := startYear; year <= endYear; year++ {
contributions, err := fetchContributionData(client, targetUser, year)
if err != nil {
return err
}
allContributions = append(allContributions, contributions)
// Generate ASCII art for each year
asciiArt, err := ascii.GenerateASCII(contributions, targetUser, year, year == startYear)
if err != nil {
if warnErr := log.Warning("Failed to generate ASCII preview: %v", err); warnErr != nil {
return warnErr
}
} else {
if year == startYear {
// For first year, show full ASCII art including header
fmt.Println(asciiArt)
} else {
// For subsequent years, skip the header
lines := strings.Split(asciiArt, "\n")
gridStart := 0
for i, line := range lines {
if strings.Contains(line, string(ascii.EmptyBlock)) ||
strings.Contains(line, string(ascii.FoundationLow)) {
gridStart = i
break
}
}
// Print just the grid and user info
fmt.Println(strings.Join(lines[gridStart:], "\n"))
}
}
}
// Generate filename
outputPath := generateOutputFilename(targetUser, startYear, endYear)
// Generate the STL file
if len(allContributions) == 1 {
return stl.GenerateSTL(allContributions[0], outputPath, targetUser, startYear)
}
return stl.GenerateSTLRange(allContributions, outputPath, targetUser, startYear, endYear)
}
// Variable for client initialization - allows for testing
var initializeGitHubClient = defaultGitHubClient
// defaultGitHubClient is the default implementation of client initialization
func defaultGitHubClient() (*github.Client, error) {
apiClient, err := api.DefaultRESTClient()
if err != nil {
return nil, fmt.Errorf("failed to create REST client: %w", err)
}
return github.NewClient(apiClient), nil
}
// fetchContributionData retrieves and formats the contribution data for the specified year.
func fetchContributionData(client *github.Client, username string, year int) ([][]types.ContributionDay, error) {
resp, err := client.FetchContributions(username, year)
if err != nil {
return nil, fmt.Errorf("failed to fetch contributions: %w", err)
}
// Convert weeks data to 2D array for STL generation
weeks := resp.Data.User.ContributionsCollection.ContributionCalendar.Weeks
contributionGrid := make([][]types.ContributionDay, len(weeks))
for i, week := range weeks {
contributionGrid[i] = week.ContributionDays
}
return contributionGrid, nil
}
// Parse year range string (e.g., "2024" or "2014-2024")
func parseYearRange(yearRange string) (startYear, endYear int, err error) {
if strings.Contains(yearRange, "-") {
parts := strings.Split(yearRange, "-")
if len(parts) != 2 {
return 0, 0, fmt.Errorf("invalid year range format")
}
startYear, err = strconv.Atoi(parts[0])
if err != nil {
return 0, 0, err
}
endYear, err = strconv.Atoi(parts[1])
if err != nil {
return 0, 0, err
}
} else {
year, err := strconv.Atoi(yearRange)
if err != nil {
return 0, 0, err
}
startYear, endYear = year, year
}
return startYear, endYear, validateYearRange(startYear, endYear)
}
// validateYearRange checks if the years are within the range
// of GitHub's launch year to the current year and if
// the start year is not greater than the end year.
func validateYearRange(startYear, endYear int) error {
currentYear := time.Now().Year()
if startYear < githubLaunchYear || endYear > currentYear {
return fmt.Errorf("years must be between %d and %d", githubLaunchYear, currentYear)
}
if startYear > endYear {
return fmt.Errorf("start year cannot be after end year")
}
return nil
}
// openGitHubProfile opens the GitHub profile page for the specified user or authenticated user
func openGitHubProfile(targetUser string, client GitHubClientInterface, b Browser) error {
if targetUser == "" {
username, err := client.GetAuthenticatedUser()
if err != nil {
return errors.New(errors.NetworkError, "failed to get authenticated user", err)
}
targetUser = username
}
profileURL := fmt.Sprintf("https://github.com/%s", targetUser)
return b.Browse(profileURL)
}