Made utility functions private and put them in their own file

cmaglie · cmaglie · commit a3d9b7061dfb · 2024-03-26T16:52:53.000+01:00
diff --git a/commands/service_board_listall.go b/commands/service_board_listall.go
@@ -46,8 +46,8 @@ func (s *arduinoCoreServerImpl) BoardListAll(ctx context.Context, req *rpc.Board
 			}
 
 			rpcPlatform := &rpc.Platform{
-				Metadata: PlatformToRPCPlatformMetadata(platform),
-				Release:  PlatformReleaseToRPC(installedPlatformRelease),
+				Metadata: platformToRPCPlatformMetadata(platform),
+				Release:  platformReleaseToRPC(installedPlatformRelease),
 			}
 
 			toTest := []string{
diff --git a/commands/service_board_search.go b/commands/service_board_search.go
@@ -67,8 +67,8 @@ func (s *arduinoCoreServerImpl) BoardSearch(ctx context.Context, req *rpc.BoardS
 						Fqbn:     board.FQBN(),
 						IsHidden: board.IsHidden(),
 						Platform: &rpc.Platform{
-							Metadata: PlatformToRPCPlatformMetadata(platform),
-							Release:  PlatformReleaseToRPC(installedPlatformRelease),
+							Metadata: platformToRPCPlatformMetadata(platform),
+							Release:  platformReleaseToRPC(installedPlatformRelease),
 						},
 					})
 				}
@@ -82,8 +82,8 @@ func (s *arduinoCoreServerImpl) BoardSearch(ctx context.Context, req *rpc.BoardS
 					foundBoards = append(foundBoards, &rpc.BoardListItem{
 						Name: strings.Trim(board.Name, " \n"),
 						Platform: &rpc.Platform{
-							Metadata: PlatformToRPCPlatformMetadata(platform),
-							Release:  PlatformReleaseToRPC(latestPlatformRelease),
+							Metadata: platformToRPCPlatformMetadata(platform),
+							Release:  platformReleaseToRPC(latestPlatformRelease),
 						},
 					})
 				}
diff --git a/commands/service_library_download.go b/commands/service_library_download.go
@@ -56,7 +56,7 @@ func (s *arduinoCoreServerImpl) LibraryDownload(req *rpc.LibraryDownloadRequest,
 		return err
 	}
 
-	version, err := ParseVersion(req.GetVersion())
+	version, err := parseVersion(req.GetVersion())
 	if err != nil {
 		return err
 	}
diff --git a/commands/service_library_install.go b/commands/service_library_install.go
@@ -109,7 +109,7 @@ func (s *arduinoCoreServerImpl) LibraryInstall(req *rpc.LibraryInstallRequest, s
 	libReleasesToInstall := map[*librariesindex.Release]*librariesmanager.LibraryInstallPlan{}
 	installLocation := libraries.FromRPCLibraryInstallLocation(req.GetInstallLocation())
 	for _, lib := range toInstall {
-		version, err := ParseVersion(lib.GetVersionRequired())
+		version, err := parseVersion(lib.GetVersionRequired())
 		if err != nil {
 			return err
 		}
diff --git a/commands/service_library_resolve_deps.go b/commands/service_library_resolve_deps.go
@@ -47,7 +47,7 @@ func (s *arduinoCoreServerImpl) LibraryResolveDependencies(ctx context.Context,
 
 func libraryResolveDependencies(lme *librariesmanager.Explorer, li *librariesindex.Index,
 	reqName, reqVersion string, noOverwrite bool) (*rpc.LibraryResolveDependenciesResponse, error) {
-	version, err := ParseVersion(reqVersion)
+	version, err := parseVersion(reqVersion)
 	if err != nil {
 		return nil, err
 	}
diff --git a/commands/service_library_uninstall.go b/commands/service_library_uninstall.go
@@ -47,7 +47,7 @@ func (s *arduinoCoreServerImpl) LibraryUninstall(req *rpc.LibraryUninstallReques
 		return err
 	}
 
-	version, err := ParseVersion(req.GetVersion())
+	version, err := parseVersion(req.GetVersion())
 	if err != nil {
 		return err
 	}
diff --git a/commands/service_platform_download.go b/commands/service_platform_download.go
@@ -48,7 +48,7 @@ func (s *arduinoCoreServerImpl) PlatformDownload(req *rpc.PlatformDownloadReques
 	}
 	defer release()
 
-	version, err := ParseVersion(req.GetVersion())
+	version, err := parseVersion(req.GetVersion())
 	if err != nil {
 		return &cmderrors.InvalidVersionError{Cause: err}
 	}
diff --git a/commands/service_platform_install.go b/commands/service_platform_install.go
@@ -53,7 +53,7 @@ func (s *arduinoCoreServerImpl) PlatformInstall(req *rpc.PlatformInstallRequest,
 		}
 		defer release()
 
-		version, err := ParseVersion(req.GetVersion())
+		version, err := parseVersion(req.GetVersion())
 		if err != nil {
 			return &cmderrors.InvalidVersionError{Cause: err}
 		}
diff --git a/commands/service_platform_search.go b/commands/service_platform_search.go
@@ -82,7 +82,7 @@ func (s *arduinoCoreServerImpl) PlatformSearch(_ context.Context, req *rpc.Platf
 	out := []*rpc.PlatformSummary{}
 	for _, platform := range res {
 		rpcPlatformSummary := &rpc.PlatformSummary{
-			Metadata: PlatformToRPCPlatformMetadata(platform),
+			Metadata: platformToRPCPlatformMetadata(platform),
 			Releases: map[string]*rpc.PlatformRelease{},
 		}
 		if installed := pme.GetInstalledPlatformRelease(platform); installed != nil {
@@ -92,7 +92,7 @@ func (s *arduinoCoreServerImpl) PlatformSearch(_ context.Context, req *rpc.Platf
 			rpcPlatformSummary.LatestVersion = latestCompatible.Version.String()
 		}
 		for _, platformRelease := range platform.GetAllReleases() {
-			rpcPlatformRelease := PlatformReleaseToRPC(platformRelease)
+			rpcPlatformRelease := platformReleaseToRPC(platformRelease)
 			rpcPlatformSummary.Releases[rpcPlatformRelease.GetVersion()] = rpcPlatformRelease
 		}
 		out = append(out, rpcPlatformSummary)
diff --git a/commands/service_platform_upgrade.go b/commands/service_platform_upgrade.go
@@ -76,8 +76,8 @@ func (s *arduinoCoreServerImpl) PlatformUpgrade(req *rpc.PlatformUpgradeRequest,
 	if platformRelease != nil {
 		syncSend.Send(&rpc.PlatformUpgradeResponse{
 			Platform: &rpc.Platform{
-				Metadata: PlatformToRPCPlatformMetadata(platformRelease.Platform),
-				Release:  PlatformReleaseToRPC(platformRelease),
+				Metadata: platformToRPCPlatformMetadata(platformRelease.Platform),
+				Release:  platformReleaseToRPC(platformRelease),
 			},
 		})
 	}
diff --git a/commands/utility_core.go b/commands/utility_core.go
@@ -20,8 +20,8 @@ import (
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 )
 
-// PlatformToRPCPlatformMetadata converts our internal structure to the RPC structure.
-func PlatformToRPCPlatformMetadata(platform *cores.Platform) *rpc.PlatformMetadata {
+// platformToRPCPlatformMetadata converts our internal structure to the RPC structure.
+func platformToRPCPlatformMetadata(platform *cores.Platform) *rpc.PlatformMetadata {
 	return &rpc.PlatformMetadata{
 		Id:                platform.String(),
 		Maintainer:        platform.Package.Maintainer,
@@ -33,10 +33,10 @@ func PlatformToRPCPlatformMetadata(platform *cores.Platform) *rpc.PlatformMetada
 	}
 }
 
-// PlatformReleaseToRPC converts our internal structure to the RPC structure.
+// platformReleaseToRPC converts our internal structure to the RPC structure.
 // Note: this function does not touch the "Installed" field of rpc.Platform as it's not always clear that the
 // platformRelease we're currently converting is actually installed.
-func PlatformReleaseToRPC(platformRelease *cores.PlatformRelease) *rpc.PlatformRelease {
+func platformReleaseToRPC(platformRelease *cores.PlatformRelease) *rpc.PlatformRelease {
 	// If the boards are not installed yet, the `platformRelease.Boards` will be a zero length slice.
 	// In such case, we have to use the `platformRelease.BoardsManifest` instead.
 	// So that we can retrieve the name of the boards at least.
diff --git a/commands/utility_grpc_streaming.go b/commands/utility_grpc_streaming.go
diff --git a/commands/utility_libraries_index_search_matcher.go b/commands/utility_libraries_index_search_matcher.go
diff --git a/commands/utility_version.go b/commands/utility_version.go
@@ -20,10 +20,10 @@ import (
 	semver "go.bug.st/relaxed-semver"
 )
 
-// ParseVersion returns the parsed version or nil if the version is
+// parseVersion returns the parsed version or nil if the version is
 // the empty string. An error is returned if the version is not valid
 // semver.
-func ParseVersion(version string) (*semver.Version, error) {
+func parseVersion(version string) (*semver.Version, error) {
 	if version == "" {
 		return nil, nil
 	}

Original file line number	Diff line number	Diff line change
`@@ -46,8 +46,8 @@ func (s arduinoCoreServerImpl) BoardListAll(ctx context.Context, req rpc.Board`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`rpcPlatform := &rpc.Platform{`
`49`		`- Metadata: PlatformToRPCPlatformMetadata(platform),`
`50`		`- Release: PlatformReleaseToRPC(installedPlatformRelease),`
	`49`	`+ Metadata: platformToRPCPlatformMetadata(platform),`
	`50`	`+ Release: platformReleaseToRPC(installedPlatformRelease),`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`toTest := []string{`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ func (s arduinoCoreServerImpl) LibraryDownload(req rpc.LibraryDownloadRequest,`
`56`	`56`	`return err`
`57`	`57`	`}`
`58`	`58`
`59`		`- version, err := ParseVersion(req.GetVersion())`
	`59`	`+ version, err := parseVersion(req.GetVersion())`
`60`	`60`	`if err != nil {`
`61`	`61`	`return err`
`62`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ func (s arduinoCoreServerImpl) LibraryInstall(req rpc.LibraryInstallRequest, s`
`109`	`109`	`libReleasesToInstall := map[librariesindex.Release]librariesmanager.LibraryInstallPlan{}`
`110`	`110`	`installLocation := libraries.FromRPCLibraryInstallLocation(req.GetInstallLocation())`
`111`	`111`	`for _, lib := range toInstall {`
`112`		`- version, err := ParseVersion(lib.GetVersionRequired())`
	`112`	`+ version, err := parseVersion(lib.GetVersionRequired())`
`113`	`113`	`if err != nil {`
`114`	`114`	`return err`
`115`	`115`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ func (s *arduinoCoreServerImpl) LibraryResolveDependencies(ctx context.Context,`
`47`	`47`
`48`	`48`	`func libraryResolveDependencies(lme librariesmanager.Explorer, li librariesindex.Index,`
`49`	`49`	`reqName, reqVersion string, noOverwrite bool) (*rpc.LibraryResolveDependenciesResponse, error) {`
`50`		`- version, err := ParseVersion(reqVersion)`
	`50`	`+ version, err := parseVersion(reqVersion)`
`51`	`51`	`if err != nil {`
`52`	`52`	`return nil, err`
`53`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ func (s arduinoCoreServerImpl) PlatformDownload(req rpc.PlatformDownloadReques`
`48`	`48`	`}`
`49`	`49`	`defer release()`
`50`	`50`
`51`		`- version, err := ParseVersion(req.GetVersion())`
	`51`	`+ version, err := parseVersion(req.GetVersion())`
`52`	`52`	`if err != nil {`
`53`	`53`	`return &cmderrors.InvalidVersionError{Cause: err}`
`54`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ func (s arduinoCoreServerImpl) PlatformInstall(req rpc.PlatformInstallRequest,`
`53`	`53`	`}`
`54`	`54`	`defer release()`
`55`	`55`
`56`		`- version, err := ParseVersion(req.GetVersion())`
	`56`	`+ version, err := parseVersion(req.GetVersion())`
`57`	`57`	`if err != nil {`
`58`	`58`	`return &cmderrors.InvalidVersionError{Cause: err}`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ func (s arduinoCoreServerImpl) PlatformSearch(_ context.Context, req rpc.Platf`
`82`	`82`	`out := []*rpc.PlatformSummary{}`
`83`	`83`	`for _, platform := range res {`
`84`	`84`	`rpcPlatformSummary := &rpc.PlatformSummary{`
`85`		`- Metadata: PlatformToRPCPlatformMetadata(platform),`
	`85`	`+ Metadata: platformToRPCPlatformMetadata(platform),`
`86`	`86`	`Releases: map[string]*rpc.PlatformRelease{},`
`87`	`87`	`}`
`88`	`88`	`if installed := pme.GetInstalledPlatformRelease(platform); installed != nil {`
`@@ -92,7 +92,7 @@ func (s arduinoCoreServerImpl) PlatformSearch(_ context.Context, req rpc.Platf`
`92`	`92`	`rpcPlatformSummary.LatestVersion = latestCompatible.Version.String()`
`93`	`93`	`}`
`94`	`94`	`for _, platformRelease := range platform.GetAllReleases() {`
`95`		`- rpcPlatformRelease := PlatformReleaseToRPC(platformRelease)`
	`95`	`+ rpcPlatformRelease := platformReleaseToRPC(platformRelease)`
`96`	`96`	`rpcPlatformSummary.Releases[rpcPlatformRelease.GetVersion()] = rpcPlatformRelease`
`97`	`97`	`}`
`98`	`98`	`out = append(out, rpcPlatformSummary)`