Merge pull request #18 from bcmi-labs/lib-features

Lib features

Author: mastrolinux

cmd/arduino_lib.go

@@ -130,11 +130,11 @@ func executeDownloadCommand(cmd *cobra.Command, args []string) error {
 	libraryOK := make([]string, 0, len(args))
 	libraryFails := make(map[string]string, len(args))
 
-	for _, libraryName := range args {
+	for i, libraryName := range args {
 		library := status.Libraries[libraryName]
 		if library != nil {
 			//found
-			_, err = libraries.DownloadAndCache(library)
+			_, err = libraries.DownloadAndCache(library, i+1, len(args))
 			if err != nil {
 				libraryFails[libraryName] = err.Error()
 			} else {
@@ -149,10 +149,10 @@ func executeDownloadCommand(cmd *cobra.Command, args []string) error {
 		prettyPrintDownload(libraryOK, libraryFails)
 	} else {
 		for _, library := range libraryOK {
-			fmt.Printf("%s - Downloaded\n", library)
+			fmt.Printf("%-10s -Downloaded\n", library)
 		}
 		for library, failure := range libraryFails {
-			fmt.Printf("%s - Error : %s\n", library, failure)
+			fmt.Printf("%-10s -Error : %s\n", library, failure)
 		}
 	}
 
@@ -184,11 +184,11 @@ func executeInstallCommand(cmd *cobra.Command, args []string) error {
 	libraryOK := make([]string, 0, len(args))
 	libraryFails := make(map[string]string, len(args))
 
-	for _, libraryName := range args {
+	for i, libraryName := range args {
 		library := status.Libraries[libraryName]
 		if library != nil {
 			//found
-			err = libraries.DownloadAndInstall(library)
+			err = libraries.DownloadAndInstall(library, i+1, len(args))
 			if err != nil {
 				libraryFails[libraryName] = err.Error()
 			} else {
@@ -202,11 +202,13 @@ func executeInstallCommand(cmd *cobra.Command, args []string) error {
 	if GlobalFlags.Verbose > 0 {
 		prettyPrintInstall(libraryOK, libraryFails)
 	} else {
-		for _, library := range libraryOK {
-			fmt.Printf("%s - Installed\n", library)
+		for i, library := range libraryOK {
+			fmt.Printf("%-10s - Installed (%d/%d)\n", library, i+1, len(libraryOK))
 		}
+		i := 1
 		for library, failure := range libraryFails {
-			fmt.Printf("%s - Error : %s\n", library, failure)
+			i++
+			fmt.Printf("%-10s - Error : %-10s (%d/%d)\n", library, failure, i, len(libraryFails))
 		}
 	}
 
@@ -298,15 +300,20 @@ func executeUninstallCommand(cmd *cobra.Command, args []string) error {
 		}
 	}
 
-	if len(libraryFails) > 0 {
-		fmt.Println("The following libraries were succesfully uninstalled:")
-		fmt.Println(strings.Join(libraryOK, " "))
-		fmt.Println("However, the uninstall process failed on the following libraries:")
-		fmt.Println(strings.Join(libraryFails, " "))
-	} else {
-		fmt.Println("All libraries successfully uninstalled")
+	if GlobalFlags.Verbose > 0 {
+		if len(libraryFails) > 0 {
+			fmt.Println("The following libraries were succesfully uninstalled:")
+			fmt.Println(strings.Join(libraryOK, " "))
+			fmt.Println("However, the uninstall process failed on the following libraries:")
+			fmt.Println(strings.Join(libraryFails, " "))
+		} else {
+			fmt.Println("All libraries successfully uninstalled")
+		}
+	} else if len(libraryFails) > 0 {
+		for _, failed := range libraryFails {
+			fmt.Printf("%-10s - Failed\n", failed)
+		}
 	}
-
 	return nil
 }
 

cmd/arduino_lib_list.go

@@ -30,7 +30,6 @@
 package cmd
 
 import (
-	"encoding/json"
 	"fmt"
 	"io/ioutil"
 	"path/filepath"
@@ -39,8 +38,8 @@ import (
 	"os"
 
 	"github.com/bcmi-labs/arduino-cli/common"
-	"github.com/bcmi-labs/arduino-cli/libraries"
 	"github.com/spf13/cobra"
+	"github.com/zieckey/goini"
 )
 
 // arduinoLibListCmd represents the list libraries command.
@@ -116,20 +115,32 @@ func executeListCommand(command *cobra.Command, args []string) {
 					continue
 				}
 
-				var jsonContent libraries.IndexRelease
-				err = json.Unmarshal(content, &jsonContent)
+				ini := goini.New()
+				err = ini.Parse(content, "\n", "=")
 				if err != nil {
-					//I use library name
+					fmt.Println(err)
+				}
+				Name, ok := ini.Get("name")
+				if !ok {
+					fileName := file.Name()
+					//replacing underscore in foldernames with spaces.
+					fileName = strings.Replace(fileName, "_", " ", -1)
+					fileName = strings.Replace(fileName, "-", " v. ", -1)
+					//I use folder name
+					libs = append(libs, fileName)
+					continue
+				}
+				Version, ok := ini.Get("version")
+				if !ok {
 					fileName := file.Name()
 					//replacing underscore in foldernames with spaces.
 					fileName = strings.Replace(fileName, "_", " ", -1)
 					fileName = strings.Replace(fileName, "-", " v. ", -1)
 					//I use folder name
 					libs = append(libs, fileName)
 					continue
-				} else {
-					libs = append(libs, fmt.Sprintf("%s v. %s", jsonContent.Name, jsonContent.Version))
 				}
+				libs = append(libs, fmt.Sprintf("%-10s v. %s", Name, Version))
 			}
 		}
 	}

cmd/pretty_print.go

@@ -1,3 +1,32 @@
+/*
+ * This file is part of arduino-cli.
+ *
+ * arduino-cli is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2017 BCMI LABS SA (http://www.arduino.cc/)
+ */
+
 package cmd
 
 import (
@@ -7,8 +36,8 @@ import (
 	"github.com/bcmi-labs/arduino-cli/libraries"
 )
 
+// prettyPrintStatus pretty prints libraries from index status.
 func prettyPrintStatus(status *libraries.StatusContext) {
-	//Pretty print libraries from index.
 	for _, name := range status.Names() {
 		if GlobalFlags.Verbose > 0 {
 			lib := status.Libraries[name]
@@ -57,7 +86,7 @@ func prettyPrintInstall(libraryOK []string, libraryFails map[string]string) {
 		}
 		fmt.Println("he installation process failed on the following libraries:")
 		for library, failure := range libraryFails {
-			fmt.Printf("%s - %s\n", library, failure)
+			fmt.Printf("%-10s -%s\n", library, failure)
 		}
 	} else {
 		fmt.Println("All libraries successfully installed")
@@ -76,7 +105,7 @@ func prettyPrintDownload(libraryOK []string, libraryFails map[string]string) {
 		}
 		fmt.Println("he download of the following libraries failed:")
 		for library, failure := range libraryFails {
-			fmt.Printf("%s - %s\n", library, failure)
+			fmt.Printf("%-10s -%s\n", library, failure)
 		}
 	} else {
 		fmt.Println("All libraries successfully downloaded")

common/common_helper.go

@@ -65,6 +65,8 @@ import (
 	"net/http"
 	"os"
 	"path/filepath"
+
+	"github.com/mitchellh/ioprogress"
 )
 
 // GetFolder gets a folder on a path, and creates it if not found.
@@ -136,8 +138,8 @@ func TruncateDir(dir string) error {
 	return nil
 }
 
-// DownloadPackage downloads a package from arduino repository.
-func DownloadPackage(URL string) ([]byte, error) {
+// DownloadPackage downloads a package from arduino repository, applying a label for the progress bar.
+func DownloadPackage(URL string, downloadLabel string, progressFile int, totalFiles int) ([]byte, error) {
 	client := http.DefaultClient
 
 	request, err := http.NewRequest("GET", URL, nil)
@@ -146,6 +148,7 @@ func DownloadPackage(URL string) ([]byte, error) {
 	}
 
 	response, err := client.Do(request)
+
 	if err != nil {
 		return nil, fmt.Errorf("Cannot fetch library. Response creation error")
 	} else if response.StatusCode != 200 {
@@ -155,7 +158,15 @@ func DownloadPackage(URL string) ([]byte, error) {
 	defer response.Body.Close()
 
 	// Download completed, now move the archive to temp location and unpack it.
-	body, err := ioutil.ReadAll(response.Body)
+	rd := &ioprogress.Reader{
+		Reader: response.Body,
+		Size:   response.ContentLength,
+		DrawFunc: ioprogress.DrawTerminalf(os.Stdout, func(progress int64, size int64) string {
+			return fmt.Sprintf("%s ... %s -%.2f %% (%d/%d)", downloadLabel, ioprogress.DrawTextFormatBytes(progress, size), float64(progress)/float64(size)*100, progressFile, totalFiles)
+		}),
+	}
+
+	body, err := ioutil.ReadAll(rd)
 	if err != nil {
 		return nil, fmt.Errorf("Cannot read response body")
 	}

debug

@@ -1,7 +1,37 @@
+/*
+ * This file is part of arduino-cli.
+ *
+ * arduino-cli is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2017 BCMI LABS SA (http://www.arduino.cc/)
+ */
+
 package libraries
 
 import (
 	"archive/zip"
+	"fmt"
 	"io/ioutil"
 	"net/http"
 	"path/filepath"
@@ -14,8 +44,8 @@ const (
 )
 
 // DownloadAndCache downloads a library without installing it
-func DownloadAndCache(library *Library) (*zip.Reader, error) {
-	zipContent, err := downloadLatest(library)
+func DownloadAndCache(library *Library, progressFiles int, totalFiles int) (*zip.Reader, error) {
+	zipContent, err := downloadLatest(library, progressFiles, totalFiles)
 	if err != nil {
 		return nil, err
 	}
@@ -29,11 +59,11 @@ func DownloadAndCache(library *Library) (*zip.Reader, error) {
 }
 
 // DownloadLatest downloads Latest version of a library.
-func downloadLatest(library *Library) ([]byte, error) {
-	return common.DownloadPackage(library.Latest.URL)
+func downloadLatest(library *Library, progressFiles int, totalFiles int) ([]byte, error) {
+	return common.DownloadPackage(library.Latest.URL, fmt.Sprintf("library %s", library.Name), progressFiles, totalFiles)
 }
 
-//DownloadLibrariesFile downloads the lib file from arduino repository.
+// DownloadLibrariesFile downloads the lib file from arduino repository.
 func DownloadLibrariesFile() error {
 	libFile, err := IndexPath()
 	if err != nil {

libraries/download.go

@@ -103,7 +103,7 @@ func (indexLib *IndexRelease) ExtractRelease() *Release {
 }
 
 // ExtractLibrary create a new Library with the information contained
-// in this index element
+// in this index element.
 func (indexLib *IndexRelease) ExtractLibrary() *Library {
 	release := indexLib.ExtractRelease()
 	return &Library{

libraries/index.go

@@ -40,13 +40,13 @@ import (
 	"github.com/bcmi-labs/arduino-cli/common"
 )
 
-var install func(*zip.Reader, string) error = common.Unzip
+var install = common.Unzip
 
 // Uninstall a library means remove its directory.
-var Uninstall func(libraryFolder string) error = os.RemoveAll
+var Uninstall = os.RemoveAll
 
 // DownloadAndInstall downloads a library and installs it to its specified location.
-func DownloadAndInstall(library *Library) error {
+func DownloadAndInstall(library *Library, progressFiles int, totalFiles int) error {
 	libFolder, err := common.GetDefaultLibFolder()
 	if err != nil {
 		return fmt.Errorf("Cannot get Lib destination directory")
@@ -59,12 +59,12 @@ func DownloadAndInstall(library *Library) error {
 
 	_, err = os.Stat(cacheFilePath)
 	if os.IsNotExist(err) {
-		zipArchive, err = DownloadAndCache(library)
+		zipArchive, err = DownloadAndCache(library, progressFiles, totalFiles)
 		if err != nil {
 			return err
 		}
 	} else {
-		fmt.Printf("%s library found in cache downloads ... using cached zip archive\n", library.Name)
+		fmt.Printf("%-10s - Cached    (%d/%d)\n", library.Name, progressFiles, totalFiles)
 		content, err := ioutil.ReadFile(cacheFilePath)
 		if err != nil {
 			return err