Merge pull request #29 from sashamelentyev/feat/gen

feat: add gen

Author: sashamelentyev

.github/workflows/ci.yaml

@@ -34,9 +34,6 @@ jobs:
       - name: Go Mod
         run: go mod download
 
-      - name: Go Generate
-        run: go generate ./... && git diff --exit-code
-
       - name: Go Build
         run: go build -v ./...
 

go.mod

@@ -2,9 +2,9 @@ module github.com/sashamelentyev/usestdlibvars
 
 go 1.19
 
-require golang.org/x/tools v0.1.11
+require golang.org/x/tools v0.1.12
 
 require (
 	golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4 // indirect
-	golang.org/x/sys v0.0.0-20211019181941-9d821ace8654 // indirect
+	golang.org/x/sys v0.0.0-20220804214406-8e32c043e418 // indirect
 )

go.sum

@@ -1,6 +1,6 @@
 golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4 h1:6zppjxzCulZykYSLyVDYbneBfbaBIQPYMevg0bEwv2s=
 golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
-golang.org/x/sys v0.0.0-20211019181941-9d821ace8654 h1:id054HUawV2/6IGm2IV8KZQjqtwAOo2CYlOToYqa0d0=
-golang.org/x/sys v0.0.0-20211019181941-9d821ace8654/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/tools v0.1.11 h1:loJ25fNOEhSXfHrpoGj91eCUThwdNX6u24rO1xnNteY=
-golang.org/x/tools v0.1.11/go.mod h1:SgwaegtQh8clINPpECJMqnxLv9I09HLqnW3RMqW0CA4=
+golang.org/x/sys v0.0.0-20220804214406-8e32c043e418 h1:9vYwv7OjYaky/tlAeD7C4oC9EsPTlaFl1H2jS++V+ME=
+golang.org/x/sys v0.0.0-20220804214406-8e32c043e418/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/tools v0.1.12 h1:VveCTK38A2rkS8ZqFY25HIDFscX5X9OoEhJd3quQmXU=
+golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=

main.go

@@ -6,6 +6,8 @@ import (
 	"github.com/sashamelentyev/usestdlibvars/pkg/analyzer"
 )
 
+//go:generate go run pkg/analyzer/internal/gen.go
+
 func main() {
 	singlechecker.Main(analyzer.New())
 }

pkg/analyzer/analyzer.go

@@ -9,6 +9,8 @@ import (
 	"golang.org/x/tools/go/analysis"
 	"golang.org/x/tools/go/analysis/passes/inspect"
 	"golang.org/x/tools/go/ast/inspector"
+
+	"github.com/sashamelentyev/usestdlibvars/pkg/analyzer/internal/mapping"
 )
 
 const (
@@ -158,45 +160,45 @@ func lookupFlag(pass *analysis.Pass, name string) bool {
 func checkHTTPMethod(pass *analysis.Pass, basicLit *ast.BasicLit) {
 	currentVal := getBasicLitValue(basicLit)
 
-	if newVal, ok := httpMethod[currentVal]; ok {
+	if newVal, ok := mapping.HTTPMethod[currentVal]; ok {
 		report(pass, basicLit.Pos(), currentVal, newVal)
 	}
 }
 
 func checkHTTPStatusCode(pass *analysis.Pass, basicLit *ast.BasicLit) {
 	currentVal := getBasicLitValue(basicLit)
 
-	if newVal, ok := httpStatusCode[currentVal]; ok {
+	if newVal, ok := mapping.HTTPStatusCode[currentVal]; ok {
 		report(pass, basicLit.Pos(), currentVal, newVal)
 	}
 }
 
 func checkTimeWeekday(pass *analysis.Pass, pos token.Pos, currentVal string) {
-	if newVal, ok := timeWeekday[currentVal]; ok {
+	if newVal, ok := mapping.TimeWeekday[currentVal]; ok {
 		report(pass, pos, currentVal, newVal)
 	}
 }
 
 func checkTimeMonth(pass *analysis.Pass, pos token.Pos, currentVal string) {
-	if newVal, ok := timeMonth[currentVal]; ok {
+	if newVal, ok := mapping.TimeMonth[currentVal]; ok {
 		report(pass, pos, currentVal, newVal)
 	}
 }
 
 func checkTimeLayout(pass *analysis.Pass, pos token.Pos, currentVal string) {
-	if newVal, ok := timeLayout[currentVal]; ok {
+	if newVal, ok := mapping.TimeLayout[currentVal]; ok {
 		report(pass, pos, currentVal, newVal)
 	}
 }
 
 func checkCryptoHash(pass *analysis.Pass, pos token.Pos, currentVal string) {
-	if newVal, ok := cryptoHash[currentVal]; ok {
+	if newVal, ok := mapping.CryptoHash[currentVal]; ok {
 		report(pass, pos, currentVal, newVal)
 	}
 }
 
 func checkDefaultRPCPath(pass *analysis.Pass, pos token.Pos, currentVal string) {
-	if newVal, ok := defaultRPCPath[currentVal]; ok {
+	if newVal, ok := mapping.DefaultRPCPath[currentVal]; ok {
 		report(pass, pos, currentVal, newVal)
 	}
 }

pkg/analyzer/internal/gen.go

@@ -0,0 +1,107 @@
+//go:build ignore
+// +build ignore
+
+package main
+
+import (
+	"bytes"
+	"embed"
+	"go/format"
+	"log"
+	"os"
+	"regexp"
+	"text/template"
+
+	"github.com/sashamelentyev/usestdlibvars/pkg/analyzer/internal/mapping"
+)
+
+//go:embed template/*
+var templateDir embed.FS
+
+func main() {
+	t := template.Must(
+		template.New("template").
+			Funcs(map[string]any{"quoteMeta": regexp.QuoteMeta}).
+			ParseFS(templateDir, "template/*.tmpl"),
+	)
+
+	operations := []struct {
+		mapping      map[string]string
+		packageName  string
+		templateName string
+		fileName     string
+	}{
+		{
+			mapping:      mapping.CryptoHash,
+			packageName:  "crypto_test",
+			templateName: "test-template.go.tmpl",
+			fileName:     "pkg/analyzer/testdata/src/a/crypto/crypto.go",
+		},
+		{
+			mapping:      mapping.HTTPMethod,
+			packageName:  "http_test",
+			templateName: "test-httpmethod.go.tmpl",
+			fileName:     "pkg/analyzer/testdata/src/a/http/method.go",
+		},
+		{
+			mapping:      mapping.HTTPStatusCode,
+			packageName:  "http_test",
+			templateName: "test-httpstatuscode.go.tmpl",
+			fileName:     "pkg/analyzer/testdata/src/a/http/statuscode.go",
+		},
+		{
+			mapping:      mapping.DefaultRPCPath,
+			packageName:  "rpc_test",
+			templateName: "test-template.go.tmpl",
+			fileName:     "pkg/analyzer/testdata/src/a/rpc/rpc.go",
+		},
+		{
+			mapping:      mapping.TimeWeekday,
+			packageName:  "time_test",
+			templateName: "test-template.go.tmpl",
+			fileName:     "pkg/analyzer/testdata/src/a/time/weekday.go",
+		},
+		{
+			mapping:      mapping.TimeMonth,
+			packageName:  "time_test",
+			templateName: "test-template.go.tmpl",
+			fileName:     "pkg/analyzer/testdata/src/a/time/month.go",
+		},
+		{
+			mapping:      mapping.TimeLayout,
+			packageName:  "time_test",
+			templateName: "test-template.go.tmpl",
+			fileName:     "pkg/analyzer/testdata/src/a/time/layout.go",
+		},
+	}
+
+	for _, operation := range operations {
+		data := map[string]any{
+			"PackageName": operation.packageName,
+			"Mapping":     operation.mapping,
+		}
+
+		if err := execute(t, operation.templateName, data, operation.fileName); err != nil {
+			log.Fatal(err)
+		}
+	}
+}
+
+func execute(t *template.Template, templateName string, data any, fileName string) error {
+	var builder bytes.Buffer
+
+	if err := t.ExecuteTemplate(&builder, templateName, data); err != nil {
+		return err
+	}
+
+	sourceData, err := format.Source(builder.Bytes())
+	if err != nil {
+		return err
+	}
+
+	if err := os.WriteFile(fileName, sourceData, os.ModePerm); err != nil {
+		return err
+	}
+
+	return nil
+}

pkg/analyzer/mapping.go renamed to pkg/analyzer/internal/mapping/mapping.go

@@ -1,4 +1,4 @@
-package analyzer
+package mapping
 
 import (
 	"crypto"
@@ -8,7 +8,7 @@ import (
 	"time"
 )
 
-var cryptoHash = map[string]string{
+var CryptoHash = map[string]string{
 	crypto.MD4.String():         "crypto.MD4.String()",
 	crypto.MD5.String():         "crypto.MD5.String()",
 	crypto.SHA1.String():        "crypto.SHA1.String()",
@@ -30,7 +30,7 @@ var cryptoHash = map[string]string{
 	crypto.BLAKE2b_512.String(): "crypto.BLAKE2b_512.String()",
 }
 
-var httpMethod = map[string]string{
+var HTTPMethod = map[string]string{
 	http.MethodGet:     "http.MethodGet",
 	http.MethodHead:    "http.MethodHead",
 	http.MethodPost:    "http.MethodPost",
@@ -42,7 +42,7 @@ var httpMethod = map[string]string{
 	http.MethodTrace:   "http.MethodTrace",
 }
 
-var httpStatusCode = map[string]string{
+var HTTPStatusCode = map[string]string{
 	strconv.Itoa(http.StatusContinue):           "http.StatusContinue",
 	strconv.Itoa(http.StatusSwitchingProtocols): "http.StatusSwitchingProtocols",
 	strconv.Itoa(http.StatusProcessing):         "http.StatusProcessing",
@@ -111,12 +111,12 @@ var httpStatusCode = map[string]string{
 	strconv.Itoa(http.StatusNetworkAuthenticationRequired): "http.StatusNetworkAuthenticationRequired",
 }
 
-var defaultRPCPath = map[string]string{
+var DefaultRPCPath = map[string]string{
 	rpc.DefaultRPCPath:   "rpc.DefaultRPCPath",
 	rpc.DefaultDebugPath: "rpc.DefaultDebugPath",
 }
 
-var timeWeekday = map[string]string{
+var TimeWeekday = map[string]string{
 	time.Sunday.String():    "time.Sunday.String()",
 	time.Monday.String():    "time.Monday.String()",
 	time.Tuesday.String():   "time.Tuesday.String()",
@@ -126,7 +126,7 @@ var timeWeekday = map[string]string{
 	time.Saturday.String():  "time.Saturday.String()",
 }
 
-var timeMonth = map[string]string{
+var TimeMonth = map[string]string{
 	time.January.String():   "time.January.String()",
 	time.February.String():  "time.February.String()",
 	time.March.String():     "time.March.String()",
@@ -141,7 +141,7 @@ var timeMonth = map[string]string{
 	time.December.String():  "time.December.String()",
 }
 
-var timeLayout = map[string]string{
+var TimeLayout = map[string]string{
 	time.Layout:      "time.Layout",
 	time.ANSIC:       "time.ANSIC",
 	time.UnixDate:    "time.UnixDate",

pkg/analyzer/internal/template/test-httpmethod.go.tmpl

@@ -0,0 +1,37 @@
+// Code generated by usestdlibvars, DO NOT EDIT.
+
+package {{ .PackageName }}
+
+import "net/http"
+
+var (
+{{- range $key, $value := .Mapping }}
+	_ = "{{ $key }}"
+{{- end }}
+)
+
+const (
+{{- range $key, $value := .Mapping }}
+	_ = "{{ $key }}"
+{{- end }}
+)
+
+func _() {
+{{- range $key, $value := .Mapping }}
+	_, _ = http.NewRequest("{{ $key }}", "", nil) // want `"{{ quoteMeta $key }}" can be replaced by {{ quoteMeta $value }}`
+{{- end }}
+}
+
+func _() {
+{{- range $key, $value := .Mapping }}
+	_, _ = http.NewRequestWithContext(nil, "{{ $key }}", "", nil) // want `"{{ quoteMeta $key }}" can be replaced by {{ quoteMeta $value }}`
+{{- end }}
+}
+
+func _() {
+{{- range $key, $value := .Mapping }}
+	_ = &http.Request{
+		Method: "{{ $key }}", // want `"{{ quoteMeta $key }}" can be replaced by {{ quoteMeta $value }}`
+	}
+{{- end }}
+}

pkg/analyzer/internal/template/test-httpstatuscode.go.tmpl

@@ -0,0 +1,31 @@
+// Code generated by usestdlibvars, DO NOT EDIT.
+
+package {{ .PackageName }}
+
+import "net/http"
+
+var (
+{{- range $key, $value := .Mapping }}
+	_ = {{ $key }}
+{{- end }}
+)
+
+const (
+{{- range $key, $value := .Mapping }}
+	_ = {{ $key }}
+{{- end }}
+)
+{{ range $key, $value := .Mapping }}
+func _() {
+	var w http.ResponseWriter
+	w.WriteHeader({{ $key }}) // want `"{{ quoteMeta $key }}" can be replaced by {{ quoteMeta $value }}`
+}
+{{ end -}}
+
+{{ range $key, $value := .Mapping }}
+func _() {
+	_ = &http.Response{
+		StatusCode: {{ $key }}, // want `"{{ quoteMeta $key }}" can be replaced by {{ quoteMeta $value }}`
+	}
+}
+{{ end -}}

pkg/analyzer/internal/template/test-template.go.tmpl

@@ -0,0 +1,33 @@
+// Code generated by usestdlibvars, DO NOT EDIT.
+
+package {{ .PackageName }}
+
+import "fmt"
+
+var (
+{{- range $key, $value := .Mapping }}
+	_ = "{{ $key }}" // want `"{{ quoteMeta $key }}" can be replaced by {{ quoteMeta $value }}`
+{{- end }}
+)
+
+const (
+{{- range $key, $value := .Mapping }}
+	_ = "{{ $key }}" // want `"{{ quoteMeta $key }}" can be replaced by {{ quoteMeta $value }}`
+{{- end }}
+)
+
+func _() {
+{{- range  $key, $value := .Mapping }}
+	_ = func(s string)string{return s}("{{ $key }}") // want `"{{ quoteMeta $key }}" can be replaced by {{ quoteMeta $value }}`
+	_ = func(s string)string{return s}("text before key {{ $key }}")
+	_ = func(s string)string{return s}("{{ $key }} text after key")
+{{- end }}
+}
+
+func _() {
+{{- range $key, $value := .Mapping }}
+	_ = fmt.Sprint("{{ $key }}") // want `"{{ quoteMeta $key }}" can be replaced by {{ quoteMeta $value }}`
+	_ = fmt.Sprint("text before key {{ $key }}")
+	_ = fmt.Sprint("{{ $key }} text after key")
+{{- end }}
+}