Merge pull request #39 from AkihiroSuda/dev

pkg/analyzer/analyzer.go: split modpath.Guesser

Author: AkihiroSuda

README.md

@@ -37,7 +37,7 @@ import 'github.com/lmittmann/tint': module 'github.com/lmittmann/tint@v1.0.7' do
 ### GitHub API rate limit
 gosocialcheck uses the GitHub API for the following operations:
 - Fetch git tags, via `api.github.com`.
-- Fetch `go.mod` and `go.sum`, via `http://raw.githubusercontent.com`.
+- Fetch `go.mod` and `go.sum`, via `https://raw.githubusercontent.com`.
 
 These API calls often fails unless the API token is set.
 

pkg/analyzer/analyzer.go

@@ -13,7 +13,6 @@ import (
 	"path/filepath"
 	"strconv"
 	"strings"
-	"sync"
 
 	"golang.org/x/mod/modfile"
 	"golang.org/x/mod/module"
@@ -30,8 +29,8 @@ type Opts struct {
 
 func New(ctx context.Context, opts Opts) (*analysis.Analyzer, error) {
 	inst := &instance{
-		Opts:    opts,
-		modDirs: make(map[string]string),
+		Opts:   opts,
+		gusser: modpath.NewGuesser(),
 	}
 	a := &analysis.Analyzer{
 		Name:             "gosocialcheck",
@@ -46,13 +45,12 @@ func New(ctx context.Context, opts Opts) (*analysis.Analyzer, error) {
 
 type instance struct {
 	Opts
-	modDirs map[string]string // key: MODULE@VER
-	mu      sync.RWMutex
+	gusser *modpath.Guesser
 }
 
 func run(ctx context.Context, inst *instance) func(*analysis.Pass) (any, error) {
 	return func(pass *analysis.Pass) (any, error) {
-		modDir, err := inst.guessModuleDir(pass)
+		modDir, err := inst.gusser.GuessModuleDir(pass)
 		if err != nil {
 			return nil, err
 		}
@@ -152,53 +150,3 @@ func parseGoSum(r io.Reader) (map[string]string, error) {
 	}
 	return res, sc.Err()
 }
-
-// guessModuleDir guess the directory that contains go.mod and go.sum.
-// This function might not be robust.
-//
-// A workaround for https://github.com/golang/go/issues/73878
-func (inst *instance) guessModuleDir(pass *analysis.Pass) (string, error) {
-	if pass.Module == nil {
-		return "", errors.New("got nil module")
-	}
-	mod := pass.Module.Path
-	modVer := pass.Module.Version
-	inst.mu.RLock()
-	k := mod
-	if modVer != "" {
-		k += "@" + modVer
-	}
-	v := inst.modDirs[k]
-	inst.mu.RUnlock()
-	if v != "" {
-		return v, nil
-	}
-	if len(pass.Files) == 0 {
-		return "", fmt.Errorf("%s: got no files", mod)
-	}
-	var sawGoBuildDir bool
-	for _, f := range pass.Files {
-		ff := pass.Fset.File(f.Pos())
-		file := ff.Name()
-		fileSlash := filepath.ToSlash(file)
-		if strings.Contains(fileSlash, "/go-build/") {
-			// tmp file like /Users/suda/Library/Caches/go-build/a0/a0f5d4693b09f2e3e24d18608f43e8540c5c52248877ef966df196f36bed5dfb-d
-			sawGoBuildDir = true
-		}
-		if strings.Contains(fileSlash, modpath.StripMajorVersion(mod)) {
-			dir, err := modpath.DirFromFileAndMod(file, mod, modVer)
-			if err != nil {
-				return "", err
-			}
-			slog.Debug("guessed module dir", "mod", mod, "modVer", modVer, "dir", dir)
-			inst.mu.Lock()
-			inst.modDirs[k] = dir
-			inst.mu.Unlock()
-			return dir, nil
-		}
-	}
-	if sawGoBuildDir {
-		return "", nil
-	}
-	return "", fmt.Errorf("could not guess the directory of module %s", k)
-}

pkg/modpath/modpath.go

@@ -1,10 +1,15 @@
 package modpath
 
 import (
+	"errors"
 	"fmt"
+	"log/slog"
 	"path/filepath"
 	"regexp"
 	"strings"
+	"sync"
+
+	"golang.org/x/tools/go/analysis"
 )
 
 func DirFromFileAndMod(filePath, mod, modVer string) (string, error) {
@@ -24,3 +29,64 @@ func DirFromFileAndMod(filePath, mod, modVer string) (string, error) {
 func StripMajorVersion(pkg string) string {
 	return regexp.MustCompile(`(/v[0-9]+)$`).ReplaceAllString(pkg, "")
 }
+
+func NewGuesser() *Guesser {
+	return &Guesser{
+		modDirs: make(map[string]string),
+	}
+}
+
+type Guesser struct {
+	modDirs map[string]string // key: MODULE@VER
+	mu      sync.RWMutex
+}
+
+// GuessModuleDir guess the directory that contains go.mod and go.sum.
+// This function might not be robust.
+//
+// A workaround for https://github.com/golang/go/issues/73878
+func (guesser *Guesser) GuessModuleDir(pass *analysis.Pass) (string, error) {
+	if pass.Module == nil {
+		return "", errors.New("got nil module")
+	}
+	mod := pass.Module.Path
+	modVer := pass.Module.Version
+	guesser.mu.RLock()
+	k := mod
+	if modVer != "" {
+		k += "@" + modVer
+	}
+	v := guesser.modDirs[k]
+	guesser.mu.RUnlock()
+	if v != "" {
+		return v, nil
+	}
+	if len(pass.Files) == 0 {
+		return "", fmt.Errorf("%s: got no files", mod)
+	}
+	var sawGoBuildDir bool
+	for _, f := range pass.Files {
+		ff := pass.Fset.File(f.Pos())
+		file := ff.Name()
+		fileSlash := filepath.ToSlash(file)
+		if strings.Contains(fileSlash, "/go-build/") {
+			// tmp file like /Users/suda/Library/Caches/go-build/a0/a0f5d4693b09f2e3e24d18608f43e8540c5c52248877ef966df196f36bed5dfb-d
+			sawGoBuildDir = true
+		}
+		if strings.Contains(fileSlash, StripMajorVersion(mod)) {
+			dir, err := DirFromFileAndMod(file, mod, modVer)
+			if err != nil {
+				return "", err
+			}
+			slog.Debug("guessed module dir", "mod", mod, "modVer", modVer, "dir", dir)
+			guesser.mu.Lock()
+			guesser.modDirs[k] = dir
+			guesser.mu.Unlock()
+			return dir, nil
+		}
+	}
+	if sawGoBuildDir {
+		return "", nil
+	}
+	return "", fmt.Errorf("could not guess the directory of module %s", k)
+}