Another round of renames without code change

Author: cmaglie

commands/core/args.go

@@ -39,7 +39,7 @@ import (
 	"github.com/bcmi-labs/arduino-cli/cores"
 )
 
-// downloadItem represents a core or tool download
+// downloadItem represents a platform or a tool to download
 // TODO: can be greatly simplified by usign directly a pointer to the Platform or Tool
 type downloadItem struct {
 	Package string
@@ -48,14 +48,14 @@ type downloadItem struct {
 
 // platformReference represents a tuple to identify a Platform
 type platformReference struct {
-	Package     string // The package where this core belongs to.
-	CoreName    string // The core name.
-	CoreVersion string // The version of the core, to get the release.
+	Package              string // The package where this Platform belongs to.
+	PlatformArchitecture string
+	PlatformVersion      string
 }
 
 var coreTupleRegexp = regexp.MustCompile("[a-zA-Z0-9]+:[a-zA-Z0-9]+(=([0-9]|[0-9].)*[0-9]+)?")
 
-// parsePlatformReferenceArgs parses a sequence of "packager:name=version" tokens and returns a CoreIDTuple slice.
+// parsePlatformReferenceArgs parses a sequence of "packager:arch=version" tokens and returns a platformReference slice.
 //
 // If version is not present it is assumed as "latest" version.
 func parsePlatformReferenceArgs(args []string) []platformReference {
@@ -71,25 +71,26 @@ func parsePlatformReferenceArgs(args []string) []platformReference {
 				split = append(split, "latest")
 			}
 			ret = append(ret, platformReference{
-				Package:     split[0],
-				CoreName:    split[1],
-				CoreVersion: split[2],
+				Package:              split[0],
+				PlatformArchitecture: split[1],
+				PlatformVersion:      split[2],
 			})
 		} else {
+			// TODO: handle errors properly
 			ret = append(ret, platformReference{
-				Package:  "invalid-arg",
-				CoreName: arg,
+				Package:              "invalid-arg",
+				PlatformArchitecture: arg,
 			})
 		}
 	}
 	return ret
 }
 
-// findDownloadItems takes a set of platformReference and returns a set of items to download and
+// findItemsToDownload takes a set of platformReference and returns a set of items to download and
 // a set of outputs for non existing platforms.
-func findDownloadItems(sc *cores.StatusContext, items []platformReference) ([]*cores.PlatformRelease, []*cores.ToolRelease, []output.ProcessResult) {
+func findItemsToDownload(sc *cores.PackagesStatus, items []platformReference) ([]*cores.PlatformRelease, []*cores.ToolRelease, []output.ProcessResult) {
 	itemC := len(items)
-	retCores := []*cores.PlatformRelease{}
+	retPlatforms := []*cores.PlatformRelease{}
 	retTools := []*cores.ToolRelease{}
 	fails := make([]output.ProcessResult, 0, itemC)
 
@@ -100,38 +101,38 @@ func findDownloadItems(sc *cores.StatusContext, items []platformReference) ([]*c
 	for _, item := range items {
 		if item.Package == "invalid-arg" {
 			fails = append(fails, output.ProcessResult{
-				ItemName: item.CoreName,
-				Error:    "Invalid item (not PACKAGER:CORE[=VERSION])",
+				ItemName: item.PlatformArchitecture,
+				Error:    "Invalid item (not PACKAGER:ARCH[=VERSION])",
 			})
 			continue
 		}
 		pkg, exists := sc.Packages[item.Package]
 		if !exists {
 			fails = append(fails, output.ProcessResult{
-				ItemName: item.CoreName,
+				ItemName: item.PlatformArchitecture,
 				Error:    fmt.Sprintf("Package %s not found", item.Package),
 			})
 			continue
 		}
-		core, exists := pkg.Plaftorms[item.CoreName]
+		platform, exists := pkg.Plaftorms[item.PlatformArchitecture]
 		if !exists {
 			fails = append(fails, output.ProcessResult{
-				ItemName: item.CoreName,
-				Error:    "Core not found",
+				ItemName: item.PlatformArchitecture,
+				Error:    "Platform not found",
 			})
 			continue
 		}
 
-		_, exists = presenceMap[item.CoreName]
+		_, exists = presenceMap[item.PlatformArchitecture]
 		if exists { //skip
 			continue
 		}
 
-		release := core.GetVersion(item.CoreVersion)
+		release := platform.GetVersion(item.PlatformVersion)
 		if release == nil {
 			fails = append(fails, output.ProcessResult{
-				ItemName: item.CoreName,
-				Error:    fmt.Sprintf("Version %s Not Found", item.CoreVersion),
+				ItemName: item.PlatformArchitecture,
+				Error:    fmt.Sprintf("Version %s Not Found", item.PlatformVersion),
 			})
 			continue
 		}
@@ -140,15 +141,15 @@ func findDownloadItems(sc *cores.StatusContext, items []platformReference) ([]*c
 		toolDeps, err := sc.GetDepsOfPlatformRelease(release)
 		if err != nil {
 			fails = append(fails, output.ProcessResult{
-				ItemName: item.CoreName,
-				Error:    fmt.Sprintf("Cannot get tool dependencies of %s core: %s", core.Name, err.Error()),
+				ItemName: item.PlatformArchitecture,
+				Error:    fmt.Sprintf("Cannot get tool dependencies of plafotmr %s: %s", platform.Name, err.Error()),
 			})
 			continue
 		}
 
-		retCores = append(retCores, release)
+		retPlatforms = append(retPlatforms, release)
 
-		presenceMap[core.Name] = true
+		presenceMap[platform.Name] = true
 		for _, tool := range toolDeps {
 			if presenceMap[tool.Tool.Name] {
 				continue
@@ -157,5 +158,5 @@ func findDownloadItems(sc *cores.StatusContext, items []platformReference) ([]*c
 			retTools = append(retTools, tool)
 		}
 	}
-	return retCores, retTools, fails
+	return retPlatforms, retTools, fails
 }

commands/core/core.go

@@ -107,7 +107,7 @@ func getInstalledStuff(stuff *[]output.InstalledStuff, folder pathutils.Path) {
 	}
 }
 
-func getPackagesStatusContext() (*cores.StatusContext, error) {
+func getPackagesStatusContext() (*cores.PackagesStatus, error) {
 	var index packageindex.Index
 	err := packageindex.LoadIndex(&index)
 	if err != nil {

commands/core/download.go

@@ -69,7 +69,7 @@ func runDownloadCommand(cmd *cobra.Command, args []string) {
 
 	logrus.Info("Preparing download")
 
-	coresToDownload, toolsToDownload, failOutputs := findDownloadItems(status, parsePlatformReferenceArgs(args))
+	coresToDownload, toolsToDownload, failOutputs := findItemsToDownload(status, parsePlatformReferenceArgs(args))
 	outputResults := output.CoreProcessResults{
 		Cores: failOutputs,
 		Tools: []output.ProcessResult{},
@@ -103,7 +103,7 @@ func downloadPlatformArchives(platforms []*cores.PlatformRelease, results *outpu
 	downloads := []releases.DownloadItem{}
 	for _, platform := range platforms {
 		downloads = append(downloads, releases.DownloadItem{
-			Name:     platform.Platform.ParentPackage.Name + ":" + platform.Platform.Name + "@" + platform.Version,
+			Name:     platform.Platform.Package.Name + ":" + platform.Platform.Name + "@" + platform.Version,
 			Resource: platform.Resource,
 		})
 	}

commands/core/install.go

@@ -69,7 +69,7 @@ func runInstallCommand(cmd *cobra.Command, args []string) {
 
 	logrus.Info("Preparing download")
 
-	coresToDownload, toolsToDownload, failOutputs := findDownloadItems(status, parsePlatformReferenceArgs(args))
+	coresToDownload, toolsToDownload, failOutputs := findItemsToDownload(status, parsePlatformReferenceArgs(args))
 	failOutputsCount := len(failOutputs)
 	outputResults := output.CoreProcessResults{
 		Cores: failOutputs,
@@ -82,12 +82,12 @@ func runInstallCommand(cmd *cobra.Command, args []string) {
 
 	logrus.Info("Installing tool dependencies")
 	for i, item := range toolsToDownload {
-		logrus.WithField("Package", item.Tool.ParentPackage.Name).
+		logrus.WithField("Package", item.Tool.Package.Name).
 			WithField("Name", item.Tool.Name).
 			WithField("Version", item.Version).
 			Info("Installing tool")
 
-		toolRoot, err := configs.ToolsFolder(item.Tool.ParentPackage.Name).Get()
+		toolRoot, err := configs.ToolsFolder(item.Tool.Package.Name).Get()
 		if err != nil {
 			formatter.PrintError(err, "Cannot get tool install path, try again.")
 			os.Exit(commands.ErrCoreConfig)
@@ -122,12 +122,12 @@ func runInstallCommand(cmd *cobra.Command, args []string) {
 	}
 
 	for i, item := range coresToDownload {
-		logrus.WithField("Package", item.Platform.ParentPackage.Name).
+		logrus.WithField("Package", item.Platform.Package.Name).
 			WithField("Name", item.Platform.Name).
 			WithField("Version", item.Version).
 			Info("Installing core")
 
-		coreRoot, err := configs.CoresFolder(item.Platform.ParentPackage.Name).Get()
+		coreRoot, err := configs.CoresFolder(item.Platform.Package.Name).Get()
 		if err != nil {
 			formatter.PrintError(err, "Cannot get core install path, try again.")
 			os.Exit(commands.ErrCoreConfig)

common/formatter/pretty_print/pretty_print_core.go

@@ -41,13 +41,13 @@ func DownloadCoreFileIndex() task.Wrapper {
 }
 
 // CorruptedCoreIndexFix pretty prints messages regarding corrupted index fixes of cores.
-func CorruptedCoreIndexFix(index packageindex.Index) (cores.StatusContext, error) {
+func CorruptedCoreIndexFix(index packageindex.Index) (cores.PackagesStatus, error) {
 	downloadTask := DownloadCoreFileIndex()
 	parseTask := coreIndexParse(index)
 
 	result := corruptedIndexFixResults(downloadTask, parseTask)
 
-	return result[1].Result.(cores.StatusContext), result[1].Error
+	return result[1].Result.(cores.PackagesStatus), result[1].Error
 }
 
 // coreIndexParse pretty prints info about parsing an index file of libraries.

cores/cores.go

@@ -40,14 +40,14 @@ import (
 
 // Platform represents a platform package.
 type Platform struct {
-	Name          string                      // The name of the Core Package.
-	Architecture  string                      // The name of the architecture of this package.
-	Category      string                      // The category which this core package belongs to.
-	Releases      map[string]*PlatformRelease // The Releases of this core package, labeled by version.
-	ParentPackage *Package                    `json:"-"`
+	Architecture string // The name of the architecture of this package.
+	Name         string
+	Category     string
+	Releases     map[string]*PlatformRelease // The Releases of this platform, labeled by version.
+	Package      *Package                    `json:"-"`
 }
 
-// PlatformRelease represents a release of a core package.
+// PlatformRelease represents a release of a plaform package.
 type PlatformRelease struct {
 	Resource     *releases.DownloadResource
 	Version      string
@@ -56,10 +56,10 @@ type PlatformRelease struct {
 	Platform     *Platform        `json:"-"`
 }
 
-// ToolDependencies is a set of tuples representing summary data of a tool dependency set.
+// ToolDependencies is a set of tool dependency
 type ToolDependencies []*ToolDependency
 
-// ToolDependency is a tuple representing summary data of a tool.
+// ToolDependency is a tuple that uniquely identifies a specific version of a Tool
 type ToolDependency struct {
 	ToolName     string
 	ToolVersion  string
@@ -75,7 +75,7 @@ func (platform *Platform) GetVersion(version string) *PlatformRelease {
 	return platform.Releases[version]
 }
 
-// Versions returns all the version numbers in this Core Package.
+// Versions returns all the version numbers in this Platform Package.
 func (platform *Platform) Versions() semver.Versions {
 	versions := make(semver.Versions, 0, len(platform.Releases))
 	for _, release := range platform.Releases {
@@ -89,7 +89,6 @@ func (platform *Platform) Versions() semver.Versions {
 }
 
 // latestVersion obtains latest version number.
-//
 // It uses lexicographics to compare version strings.
 func (platform *Platform) latestVersion() string {
 	versions := platform.Versions()

cores/install_uninstall.go

@@ -47,11 +47,11 @@ import (
 // respects umask on linux.
 var DirPermissions os.FileMode = 0777
 
-// Install installs a specific release of a core.
+// InstallPlatform installs a specific release of a platform.
 // TODO: But why not passing the Platform?
-func InstallPlatform(destCoresDir string, release *releases.DownloadResource) error {
+func InstallPlatform(destDir string, release *releases.DownloadResource) error {
 	if release == nil {
-		return errors.New("Not existing version of the core")
+		return errors.New("Not existing version of the platform")
 	}
 
 	cacheFilePath, err := releases.ArchivePath(release)
@@ -65,26 +65,26 @@ func InstallPlatform(destCoresDir string, release *releases.DownloadResource) er
 		return err
 	}
 	tempFolder := filepath.Join(arduinoFolder, "tmp", "packages",
-		fmt.Sprintf("core-%d", time.Now().Unix()))
+		fmt.Sprintf("platform-%d", time.Now().Unix()))
 	err = os.MkdirAll(tempFolder, DirPermissions)
 	if err != nil {
 		return err
 	}
 	defer os.RemoveAll(tempFolder)
 
 	// Make container dir
-	destCoresDirParent := filepath.Dir(destCoresDir)
-	err = os.MkdirAll(destCoresDirParent, DirPermissions)
+	destDirParent := filepath.Dir(destDir)
+	err = os.MkdirAll(destDirParent, DirPermissions)
 	if err != nil {
 		return err
 	}
 	defer func() {
 		// cleaning empty directories
-		if empty, _ := IsDirEmpty(destCoresDir); empty {
-			os.RemoveAll(destCoresDir)
+		if empty, _ := IsDirEmpty(destDir); empty {
+			os.RemoveAll(destDir)
 		}
-		if empty, _ := IsDirEmpty(destCoresDirParent); empty {
-			os.RemoveAll(destCoresDirParent)
+		if empty, _ := IsDirEmpty(destDirParent); empty {
+			os.RemoveAll(destDirParent)
 		}
 	}()
 
@@ -99,17 +99,17 @@ func InstallPlatform(destCoresDir string, release *releases.DownloadResource) er
 		return err
 	}
 
-	root := coreRealRoot(tempFolder)
+	root := platformRealRoot(tempFolder)
 	if root == "invalid" {
 		return errors.New("invalid archive structure")
 	}
 
-	err = os.Rename(root, destCoresDir)
+	err = os.Rename(root, destDir)
 	if err != nil {
 		return err
 	}
 
-	err = createPackageFile(destCoresDir)
+	err = createPackageFile(destDir)
 	if err != nil {
 		return err
 	}
@@ -207,7 +207,7 @@ func IsDirEmpty(path string) (bool, error) {
 	return false, err
 }
 
-func coreRealRoot(root string) string {
+func platformRealRoot(root string) string {
 	realRoot := "invalid"
 	filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
 		if strings.HasSuffix(path, "platform.txt") {

cores/packageindex/index.go

@@ -110,8 +110,8 @@ type indexHelp struct {
 }
 
 // CreateStatusContext creates a status context from index data.
-func (index Index) CreateStatusContext() cores.StatusContext {
-	res := cores.StatusContext{
+func (index Index) CreateStatusContext() cores.PackagesStatus {
+	res := cores.PackagesStatus{
 		Packages: map[string]*cores.Package{},
 	}
 	for _, p := range index.Packages {
@@ -135,7 +135,7 @@ func (pack indexPackage) extractPackage() *cores.Package {
 		name := tool.Name
 		if p.Tools[name] == nil {
 			p.Tools[name] = tool.extractTool()
-			p.Tools[name].ParentPackage = p
+			p.Tools[name].Package = p
 		}
 		p.Tools[name].Releases[tool.Version] = tool.extractToolRelease()
 		p.Tools[name].Releases[tool.Version].Tool = p.Tools[name]
@@ -145,7 +145,7 @@ func (pack indexPackage) extractPackage() *cores.Package {
 		name := platform.Architecture
 		if p.Plaftorms[name] == nil {
 			p.Plaftorms[name] = platform.extractPlatform()
-			p.Plaftorms[name].ParentPackage = p
+			p.Plaftorms[name].Package = p
 		}
 		release := platform.extractPlatformRelease()
 		release.Platform = p.Plaftorms[name]